Class FixedRateConfig.Builder

java.lang.Object

io.helidon.scheduling.TaskConfig.BuilderBase<FixedRateConfig.Builder, FixedRateConfig>

io.helidon.scheduling.FixedRateConfig.BuilderBase<FixedRateConfig.Builder, FixedRateConfig>

io.helidon.scheduling.FixedRateConfig.Builder

All Implemented Interfaces:

Prototype.Builder<FixedRateConfig.Builder, FixedRateConfig>, Builder<FixedRateConfig.Builder, FixedRate>, ConfigBuilderSupport.ConfiguredBuilder<FixedRateConfig.Builder, FixedRateConfig>, Supplier<FixedRate>

Enclosing interface:

FixedRateConfig

public static class FixedRateConfig.Builder
extends FixedRateConfig.BuilderBase<FixedRateConfig.Builder, FixedRateConfig>
implements Builder<FixedRateConfig.Builder, FixedRate>

Fluent API builder for FixedRate.

Nested Class Summary

Nested classes/interfaces inherited from class FixedRateConfig.BuilderBase

FixedRateConfig.BuilderBase.FixedRateConfigImpl

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.

Method Summary

Modifier and Type	Method	Description
FixedRate	build()	Create an instance from this builder.
FixedRateConfig	buildPrototype()	Create an instance of the prototype.

Methods inherited from class FixedRateConfig.BuilderBase

config, delayBy, delayBy, delayType, delayType, from, from, interval, interval, preBuildPrototype, task, task, toString, validatePrototype

Modifier and Type	Method	Description
FixedRateConfig.Builder	config(Config config)	Update builder from configuration (node of this type).
Duration	delayBy()	Initial delay of the first invocation.
FixedRateConfig.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.
FixedRateConfig.Builder	delayType(FixedRate.DelayType delayType)	Configure whether the interval between the invocations should be calculated from the time when previous task started or ended.
FixedRateConfig.Builder	from(FixedRateConfig prototype)	Update this builder from an existing prototype instance.
FixedRateConfig.Builder	from(FixedRateConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
Optional<Duration>	interval()	Fixed interval between each invocation.
FixedRateConfig.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.
FixedRateConfig.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
FixedRateConfig.Builder	clearId()	Clear existing value of id.
protected Optional<Config>	config()	Configuration used to configure this instance.
boolean	enabled()	Whether the task is enabled.
FixedRateConfig.Builder	enabled(boolean enabled)	Whether the task is enabled.
Optional<ScheduledExecutorService>	executor()	Custom ScheduledExecutorService used for executing scheduled task.
FixedRateConfig.Builder	executor(ScheduledExecutorService executor)	Custom ScheduledExecutorService used for executing scheduled task.
FixedRateConfig.Builder	from(TaskConfig prototype)	Update this builder from an existing prototype instance.
FixedRateConfig.Builder	from(TaskConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
Optional<String>	id()	Identification of the started task.
FixedRateConfig.Builder	id(String id)	Identification of the started task.
Optional<ServiceRegistry>	serviceRegistry()	Service registry used to discover providers and services.
FixedRateConfig.Builder	serviceRegistry(ServiceRegistry serviceRegistry)	Service registry used to discover providers and services.
Optional<TaskManager>	taskManager()	Task manager that will manage the created task.
FixedRateConfig.Builder	taskManager(TaskManager taskManager)	Task manager that will manage the created task.
boolean	taskManagerDiscoverServices()	Service discovery flag for TaskConfig.BuilderBase.taskManager().
FixedRateConfig.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 Builder

get, identity, update

Modifier and Type	Method	Description
default FixedRate	get()
default FixedRateConfig.Builder	identity()	Instance of this builder as the correct type.
default FixedRateConfig.Builder	update(Consumer<FixedRateConfig.Builder> consumer)	Update the builder in a fluent API way.

Methods inherited from interface Prototype.Builder

self

Modifier and Type	Method	Description
default FixedRateConfig.Builder	self()	Instance of this builder as the correct type.

Method Details

buildPrototype

public FixedRateConfig buildPrototype()

Create an instance of the prototype. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

buildPrototype in interface Prototype.Builder<FixedRateConfig.Builder, FixedRateConfig>

Returns:

an instance of the setup object created from this builder

build

public FixedRate build()

Create an instance from this builder. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

build in interface Builder<FixedRateConfig.Builder, FixedRate>

Returns:

instance of the built type