io.helidon.scheduling.TaskConfig.BuilderBase<BUILDER,PROTOTYPE>

io.helidon.scheduling.FixedRateConfig.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:: FixedRateConfig.Builder

Enclosing interface:: FixedRateConfig

public abstract static class FixedRateConfig.BuilderBase<BUILDER extends FixedRateConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends FixedRateConfig> extends TaskConfig.BuilderBase<BUILDER,PROTOTYPE> implements ConfigBuilderSupport.ConfiguredBuilder<BUILDER,PROTOTYPE>

Fluent API builder base for FixedRateConfig.

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

protected static class

FixedRateConfig.BuilderBase.FixedRateConfigImpl

Generated implementation of the prototype, can be extended by descendant prototype implementations.

Nested classes/interfaces inherited from class io.helidon.scheduling.TaskConfig.BuilderBase
TaskConfig.BuilderBase.TaskConfigImpl
Constructor Summary

Constructors

Modifier

Constructor

Description

protected

BuilderBase()

Protected to support extensibility.
Method Summary

Modifier and Type

Method

Description

BUILDER

config(Config config)

Deprecated.
use config(io.helidon.config.Config)

BUILDER

config(Config config)

Update builder from configuration (node of this type).

Optional<Long>

delay()

Deprecated, for removal: This API element is subject to removal in a future version.
This option is deprecated, use interval instead

BUILDER

delay(long delay)

Deprecated, for removal: This API element is subject to removal in a future version.
This option is deprecated, use interval instead

Duration

delayBy()

Initial delay of the first invocation.

BUILDER

delayBy(Duration delayBy)

Initial delay of the first invocation.

FixedRate.DelayType

delayType()

Configure whether the interval between the invocations should be calculated from the time when previous task started or ended.

BUILDER

delayType(FixedRate.DelayType delayType)

Configure whether the interval between the invocations should be calculated from the time when previous task started or ended.

BUILDER

from(FixedRateConfig prototype)

Update this builder from an existing prototype instance.

BUILDER

from(FixedRateConfig.BuilderBase<?,?> builder)

Update this builder from an existing prototype builder instance.

Optional<Long>

initialDelay()

Deprecated, for removal: This API element is subject to removal in a future version.
This option is deprecated, use delayBy instead

BUILDER

initialDelay(long initialDelay)

Deprecated, for removal: This API element is subject to removal in a future version.
This option is deprecated, use delayBy instead

Optional<Duration>

interval()

Fixed interval between each invocation.

BUILDER

interval(Duration interval)

Fixed interval between each invocation.

protected void

preBuildPrototype()

Handles providers and decorators.

Optional<ServiceRegistry>

serviceRegistry()

Service registry used to discover providers and services.

BUILDER

serviceRegistry(ServiceRegistry serviceRegistry)

Service registry used to discover providers and services.

Optional<ScheduledConsumer<FixedRateInvocation>>

task()

Task to be scheduled for execution.

BUILDER

task(ScheduledConsumer<FixedRateInvocation> task)

Task to be scheduled for execution.

boolean

taskManagerDiscoverServices()

Service discovery flag for TaskConfig.BuilderBase.taskManager().

BUILDER

taskManagerDiscoverServices(boolean taskManagerDiscoverServices)

Service discovery flag for TaskConfig.BuilderBase.taskManager().

TimeUnit

timeUnit()

Deprecated, for removal: This API element is subject to removal in a future version.
as duration is used for new options, this option is not needed

BUILDER

timeUnit(TimeUnit timeUnit)

Deprecated, for removal: This API element is subject to removal in a future version.
as duration is used for new options, this option is not needed

String

toString()

protected void

validatePrototype()

Validates required properties.

Methods inherited from class io.helidon.scheduling.TaskConfig.BuilderBase
clearId, config, enabled, enabled, executor, executor, from, from, id, id, taskManager, taskManager

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.helidon.builder.api.Prototype.Builder
buildPrototype, self

Constructor Details
- BuilderBase
  
  protected BuilderBase()
  
  Protected to support extensibility.
Method Details
- from
  
  public BUILDER from(FixedRateConfig 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(FixedRateConfig.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 FixedRateConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends FixedRateConfig>
  
  Overrides:
  
  config in class TaskConfig.BuilderBase<BUILDER extends FixedRateConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends FixedRateConfig>
  
  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 FixedRateConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends FixedRateConfig>
  
  Overrides:
  
  config in class TaskConfig.BuilderBase<BUILDER extends FixedRateConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends FixedRateConfig>
  
  Parameters:
  
  config - configuration instance used to obtain values to update this builder
  
  Returns:
  
  updated builder instance
- initialDelay
  
  @Deprecated(since="4.2.0", forRemoval=true) public BUILDER initialDelay(long initialDelay)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  This option is deprecated, use delayBy instead
  
  Initial delay of the first invocation. Time unit is by default TimeUnit.SECONDS, can be specified with timeUnit().
  Parameters:
  
  initialDelay - initial delay value
  
  Returns:
  
  updated builder instance
  
  See Also:
  
  initialDelay()
- delay
  
  @Deprecated(since="4.2.0", forRemoval=true) public BUILDER delay(long delay)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  This option is deprecated, use interval instead
  
  Fixed rate delay between each invocation. Time unit is by default TimeUnit.SECONDS, can be specified with timeUnit(java.util.concurrent.TimeUnit).
  Parameters:
  
  delay - delay between each invocation
  
  Returns:
  
  updated builder instance
  
  See Also:
  
  delay()
- timeUnit
  
  @Deprecated(since="4.2.0", forRemoval=true) public BUILDER timeUnit(TimeUnit timeUnit)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  as duration is used for new options, this option is not needed
  
  TimeUnit used for interpretation of values provided with delay(long) and initialDelay(long).
  Parameters:
  
  timeUnit - time unit for interpreting values in delay(long) and initialDelay(long)
  
  Returns:
  
  updated builder instance
  
  See Also:
  
  timeUnit()
- delayBy
  
  public BUILDER delayBy(Duration delayBy)
  
  Initial delay of the first invocation.
  Parameters:
  
  delayBy - initial delay duration
  
  Returns:
  
  updated builder instance
  
  See Also:
  
  delayBy()
- interval
  
  public BUILDER interval(Duration interval)
  
  Fixed interval between each invocation.
  Parameters:
  
  interval - interval between each invocation
  
  Returns:
  
  updated builder instance
  
  See Also:
  
  interval()
- delayType
  
  public BUILDER delayType(FixedRate.DelayType delayType)
  
  Configure whether the interval between the invocations should be calculated from the time when previous task started or ended. Delay type is by default FixedRate.DelayType.SINCE_PREVIOUS_START.
  Parameters:
  
  delayType - delay type
  
  Returns:
  
  updated builder instance
  
  See Also:
  
  delayType()
- task
  
  public BUILDER task(ScheduledConsumer<FixedRateInvocation> task)
  
  Task to be scheduled for execution.
  Parameters:
  
  task - scheduled for execution
  
  Returns:
  
  updated builder instance
  
  See Also:
  
  task()
- taskManagerDiscoverServices
  
  public BUILDER taskManagerDiscoverServices(boolean taskManagerDiscoverServices)
  
  Service discovery flag for TaskConfig.BuilderBase.taskManager(). If set to true, services will be discovered from Java service loader, or Helidon ServiceRegistry.
  Overrides:
  
  taskManagerDiscoverServices in class TaskConfig.BuilderBase<BUILDER extends FixedRateConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends FixedRateConfig>
  
  Parameters:
  
  taskManagerDiscoverServices - whether to enable automatic service discovery
  
  Returns:
  
  updated builder instance
  
  See Also:
  
  taskManagerDiscoverServices()
- serviceRegistry
  
  public BUILDER serviceRegistry(ServiceRegistry serviceRegistry)
  
  Service registry used to discover providers and services. Provide an explicit registry instance to use.
  If not configured, the GlobalServiceRegistry would be used to discover services.
  Overrides:
  
  serviceRegistry in class TaskConfig.BuilderBase<BUILDER extends FixedRateConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends FixedRateConfig>
  
  Parameters:
  
  serviceRegistry - service registry to use
  
  Returns:
  
  updated builder instance
  
  See Also:
  
  serviceRegistry()
- initialDelay
  
  @Deprecated(since="4.2.0", forRemoval=true) public Optional<Long> initialDelay()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  This option is deprecated, use delayBy instead
  
  Initial delay of the first invocation. Time unit is by default TimeUnit.SECONDS, can be specified with timeUnit().
  
  Returns:
  
  initial delay value
- delay
  
  @Deprecated(since="4.2.0", forRemoval=true) public Optional<Long> delay()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  This option is deprecated, use interval instead
  
  Fixed rate delay between each invocation. Time unit is by default TimeUnit.SECONDS, can be specified with timeUnit(java.util.concurrent.TimeUnit).
  
  Returns:
  
  delay between each invocation
- timeUnit
  
  @Deprecated(since="4.2.0", forRemoval=true) public TimeUnit timeUnit()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  as duration is used for new options, this option is not needed
  
  TimeUnit used for interpretation of values provided with delay(long) and initialDelay(long).
  
  Returns:
  
  time unit for interpreting values in delay(long) and initialDelay(long)
- delayBy
  
  public Duration delayBy()
  
  Initial delay of the first invocation.
  
  Returns:
  
  initial delay duration
- interval
  
  public Optional<Duration> interval()
  
  Fixed interval between each invocation.
  
  Returns:
  
  interval between each invocation
- delayType
  
  public FixedRate.DelayType delayType()
  
  Configure whether the interval between the invocations should be calculated from the time when previous task started or ended. Delay type is by default FixedRate.DelayType.SINCE_PREVIOUS_START.
  
  Returns:
  
  delay type
- task
  
  public Optional<ScheduledConsumer<FixedRateInvocation>> task()
  
  Task to be scheduled for execution.
  
  Returns:
  
  scheduled for execution
- taskManagerDiscoverServices
  
  public boolean taskManagerDiscoverServices()
  
  Service discovery flag for TaskConfig.BuilderBase.taskManager(). If set to true, services will be discovered from Java service loader, or Helidon ServiceRegistry.
  
  Overrides:
  
  taskManagerDiscoverServices in class TaskConfig.BuilderBase<BUILDER extends FixedRateConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends FixedRateConfig>
  
  Returns:
  
  whether to enable automatic service discovery
- serviceRegistry
  
  public Optional<ServiceRegistry> serviceRegistry()
  
  Service registry used to discover providers and services. Provide an explicit registry instance to use.
  If not configured, the GlobalServiceRegistry would be used to discover services.
  
  Overrides:
  
  serviceRegistry in class TaskConfig.BuilderBase<BUILDER extends FixedRateConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends FixedRateConfig>
  
  Returns:
  
  service registry to use
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class TaskConfig.BuilderBase<BUILDER extends FixedRateConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends FixedRateConfig>
- preBuildPrototype
  
  protected void preBuildPrototype()
  
  Handles providers and decorators.
  
  Overrides:
  
  preBuildPrototype in class TaskConfig.BuilderBase<BUILDER extends FixedRateConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends FixedRateConfig>
- validatePrototype
  
  protected void validatePrototype()
  
  Validates required properties.
  
  Overrides:
  
  validatePrototype in class TaskConfig.BuilderBase<BUILDER extends FixedRateConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends FixedRateConfig>

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

Nested Class Summary

Nested classes/interfaces inherited from class io.helidon.scheduling.TaskConfig.BuilderBase

Constructor Summary

Method Summary

Methods inherited from class io.helidon.scheduling.TaskConfig.BuilderBase

Methods inherited from class java.lang.Object

Methods inherited from interface io.helidon.builder.api.Prototype.Builder

Constructor Details

BuilderBase

Method Details

from

from

config

config

initialDelay

delay

timeUnit

delayBy

interval

delayType

task

taskManagerDiscoverServices

serviceRegistry