Module io.helidon.scheduling
Package io.helidon.scheduling

Class TaskConfig.BuilderBase<BUILDER extends TaskConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends TaskConfig>

java.lang.Object
io.helidon.scheduling.TaskConfig.BuilderBase<BUILDER,PROTOTYPE>
Type Parameters:
BUILDER - type of the builder extending this abstract builder
PROTOTYPE - type of the prototype interface that would be built by Prototype.Builder.buildPrototype()
All Implemented Interfaces:
Prototype.Builder<BUILDER,PROTOTYPE>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>, ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>
Direct Known Subclasses:
CronConfig.BuilderBase, FixedRateConfig.BuilderBase, TaskConfig.Builder
Enclosing interface:
TaskConfig
public abstract static class TaskConfig.BuilderBase<BUILDER extends TaskConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends TaskConfig> extends Object implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>
Fluent API builder base for TaskConfig.

  • Constructor Details

    • BuilderBase

      protected BuilderBase()
      Protected to support extensibility.

  • Method Details

    • from

      public BUILDER from(TaskConfig prototype)
      Update this builder from an existing prototype instance. This method disables automatic service discovery.
      Parameters:
      prototype - existing prototype to update this builder from
      Returns:
      updated builder instance

    • from

      public BUILDER from(TaskConfig.BuilderBase<?,?> builder)
      Update this builder from an existing prototype builder instance.
      Parameters:
      builder - existing builder prototype to update this builder from
      Returns:
      updated builder instance

    • config

      @Deprecated public BUILDER config(Config config)
      Deprecated.
      use config(io.helidon.config.Config)
      Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.
      Specified by:
      config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends TaskConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends TaskConfig>
      Parameters:
      config - configuration instance used to obtain values to update this builder
      Returns:
      updated builder instance

    • config

      public BUILDER config(Config config)
      Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.
      Specified by:
      config in interface ConfigBuilderSupport.ConfiguredBuilder<BUILDER extends TaskConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends TaskConfig>
      Parameters:
      config - configuration instance used to obtain values to update this builder
      Returns:
      updated builder instance

    • serviceRegistry

      public BUILDER serviceRegistry(ServiceRegistry registry)
      Provide an explicit registry instance to use.

      If not configured, the GlobalServiceRegistry would be used to discover services.

      Parameters:
      registry - service registry instance
      Returns:
      updated builder instance

    • executor

      public BUILDER executor(ScheduledExecutorService executor)
      Custom ScheduledExecutorService used for executing scheduled task.
      Parameters:
      executor - custom ScheduledExecutorService
      Returns:
      updated builder instance
      See Also:

    • taskManager

      public BUILDER taskManager(TaskManager taskManager)
      Task manager that will manage the created task.
      Parameters:
      taskManager - task manager, by default taken from the global service registry
      Returns:
      updated builder instance
      See Also:

    • clearId

      public BUILDER clearId()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • id

      public BUILDER id(String id)
      Identification of the started task. This can be used to later look up the instance, for example to cancel it.
      Parameters:
      id - task id, if not provided via configuration or builder, the configured task will generate a unique ID
      Returns:
      updated builder instance
      See Also:

    • executor

      public Optional<ScheduledExecutorService> executor()
      Custom ScheduledExecutorService used for executing scheduled task.
      Returns:
      the executor

    • taskManager

      public Optional<TaskManager> taskManager()
      Task manager that will manage the created task.
      Returns:
      the task manager

    • id

      public Optional<String> id()
      Identification of the started task. This can be used to later look up the instance, for example to cancel it.
      Returns:
      the id

    • config

      public Optional<Config> config()
      If this instance was configured, this would be the config instance used.
      Returns:
      config node used to configure this builder, or empty if not configured

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • preBuildPrototype

      protected void preBuildPrototype()
      Handles providers and decorators.

    • validatePrototype

      protected void validatePrototype()
      Validates required properties.