Class CronConfig.Builder

java.lang.Object

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

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

io.helidon.scheduling.CronConfig.Builder

All Implemented Interfaces:

Prototype.Builder<CronConfig.Builder, CronConfig>, Builder<CronConfig.Builder, Cron>, ConfigBuilderSupport.ConfiguredBuilder<CronConfig.Builder, CronConfig>, Supplier<Cron>

Enclosing interface:

CronConfig

public static class CronConfig.Builder
extends CronConfig.BuilderBase<CronConfig.Builder, CronConfig>
implements Builder<CronConfig.Builder, Cron>

Fluent API builder for Cron.

Nested Class Summary

Nested classes/interfaces inherited from class CronConfig.BuilderBase

CronConfig.BuilderBase.CronConfigImpl

Modifier and Type	Class	Description
protected static class	CronConfig.BuilderBase.CronConfigImpl	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
Cron	build()	Create an instance from this builder.
CronConfig	buildPrototype()	Create an instance of the prototype.

Methods inherited from class CronConfig.BuilderBase

concurrentExecution, concurrentExecution, config, expression, expression, from, from, preBuildPrototype, task, task, toString, validatePrototype, zone, zone

Modifier and Type	Method	Description
boolean	concurrentExecution()	Allow concurrent execution if previous task didn't finish before next execution.
CronConfig.Builder	concurrentExecution(boolean concurrentExecution)	Allow concurrent execution if previous task didn't finish before next execution.
CronConfig.Builder	config(Config config)	Update builder from configuration (node of this type).
Optional<String>	expression()	Cron expression for specifying period of execution.
CronConfig.Builder	expression(String expression)	Cron expression for specifying period of execution.
CronConfig.Builder	from(CronConfig prototype)	Update this builder from an existing prototype instance.
CronConfig.Builder	from(CronConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
protected void	preBuildPrototype()	Handles providers and decorators.
Optional<ScheduledConsumer<CronInvocation>>	task()	Task to be scheduled for execution.
CronConfig.Builder	task(ScheduledConsumer<CronInvocation> task)	Task to be scheduled for execution.
String	toString()
protected void	validatePrototype()	Validates required properties.
ZoneId	zone()	Time zone to use for cron expression evaluation.
CronConfig.Builder	zone(ZoneId zone)	Time zone to use for cron expression evaluation.

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
CronConfig.Builder	clearId()	Clear existing value of id.
protected Optional<Config>	config()	Configuration used to configure this instance.
boolean	enabled()	Whether the task is enabled.
CronConfig.Builder	enabled(boolean enabled)	Whether the task is enabled.
Optional<ScheduledExecutorService>	executor()	Custom ScheduledExecutorService used for executing scheduled task.
CronConfig.Builder	executor(ScheduledExecutorService executor)	Custom ScheduledExecutorService used for executing scheduled task.
CronConfig.Builder	from(TaskConfig prototype)	Update this builder from an existing prototype instance.
CronConfig.Builder	from(TaskConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
Optional<String>	id()	Identification of the started task.
CronConfig.Builder	id(String id)	Identification of the started task.
Optional<ServiceRegistry>	serviceRegistry()	Service registry used to discover providers and services.
CronConfig.Builder	serviceRegistry(ServiceRegistry serviceRegistry)	Service registry used to discover providers and services.
Optional<TaskManager>	taskManager()	Task manager that will manage the created task.
CronConfig.Builder	taskManager(TaskManager taskManager)	Task manager that will manage the created task.
boolean	taskManagerDiscoverServices()	Service discovery flag for TaskConfig.BuilderBase.taskManager().
CronConfig.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 Cron	get()
default CronConfig.Builder	identity()	Instance of this builder as the correct type.
default CronConfig.Builder	update(Consumer<CronConfig.Builder> consumer)	Update the builder in a fluent API way.

Methods inherited from interface Prototype.Builder

self

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

Method Details

buildPrototype

public CronConfig 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<CronConfig.Builder, CronConfig>

Returns:

an instance of the setup object created from this builder

build

public Cron 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<CronConfig.Builder, Cron>

Returns:

instance of the built type