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

java.lang.Object

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>

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 TaskConfig.BuilderBase

TaskConfig.BuilderBase.TaskConfigImpl

Modifier and Type	Class	Description
protected static class	TaskConfig.BuilderBase.TaskConfigImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BuilderBase()	Protected to support extensibility.

Method Summary

Modifier and Type	Method	Description
BUILDER	config(Config config)	Update builder from configuration (node of this type).
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<Duration>	interval()	Fixed interval between each invocation.
BUILDER	interval(Duration interval)	Fixed interval between each invocation.
protected void	preBuildPrototype()	Handles providers and decorators.
Optional<ScheduledConsumer<FixedRateInvocation>>	task()	Task to be scheduled for execution.
BUILDER	task(ScheduledConsumer<FixedRateInvocation> task)	Task to be scheduled for execution.
String	toString()
protected void	validatePrototype()	Validates required properties.

Methods inherited from class TaskConfig.BuilderBase

clearId, config, enabled, enabled, executor, executor, from, from, id, id, serviceRegistry, serviceRegistry, taskManager, taskManager, taskManagerDiscoverServices, taskManagerDiscoverServices

Modifier and Type	Method	Description
BUILDER	clearId()	Clear existing value of id.
protected Optional<Config>	config()	Configuration used to configure this instance.
boolean	enabled()	Whether the task is enabled.
BUILDER	enabled(boolean enabled)	Whether the task is enabled.
Optional<ScheduledExecutorService>	executor()	Custom ScheduledExecutorService used for executing scheduled task.
BUILDER	executor(ScheduledExecutorService executor)	Custom ScheduledExecutorService used for executing scheduled task.
BUILDER	from(TaskConfig prototype)	Update this builder from an existing prototype instance.
BUILDER	from(TaskConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
Optional<String>	id()	Identification of the started task.
BUILDER	id(String id)	Identification of the started task.
Optional<ServiceRegistry>	serviceRegistry()	Service registry used to discover providers and services.
BUILDER	serviceRegistry(ServiceRegistry serviceRegistry)	Service registry used to discover providers and services.
Optional<TaskManager>	taskManager()	Task manager that will manage the created task.
BUILDER	taskManager(TaskManager taskManager)	Task manager that will manage the created task.
boolean	taskManagerDiscoverServices()	Service discovery flag for TaskConfig.BuilderBase.taskManager().
BUILDER	taskManagerDiscoverServices(boolean taskManagerDiscoverServices)	Service discovery flag for TaskConfig.BuilderBase.taskManager().

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface Prototype.Builder

buildPrototype, self

Modifier and Type	Method	Description
PROTOTYPE	buildPrototype()	Create an instance of the Prototype.
default BUILDER	self()	Instance of this builder as the correct type.

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

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

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()

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

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>