Module io.helidon.scheduling

Package io.helidon.scheduling

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

java.lang.Object

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

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

Enclosing interface:

CronConfig

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

Fluent API builder base for CronConfig.

Nested Class Summary

Nested Classes

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 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
boolean	concurrentExecution()	Allow concurrent execution if previous task didn't finish before next execution.
BUILDER	concurrentExecution(boolean concurrentExecution)	Allow concurrent execution if previous task didn't finish before next execution.
BUILDER	config(Config config)	Deprecated. use config(io.helidon.config.Config)
BUILDER	config(Config config)	Update builder from configuration (node of this type).
Optional<String>	expression()	Cron expression for specifying period of execution.
BUILDER	expression(String expression)	Cron expression for specifying period of execution.
BUILDER	from(CronConfig prototype)	Update this builder from an existing prototype instance.
BUILDER	from(CronConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
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<CronInvocation>>	task()	Task to be scheduled for execution.
BUILDER	task(ScheduledConsumer<CronInvocation> 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().
String	toString()
protected void	validatePrototype()	Validates required properties.
ZoneId	zone()	Time zone to use for cron expression evaluation.
BUILDER	zone(ZoneId zone)	Time zone to use for cron expression evaluation.

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(CronConfig 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(CronConfig.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 CronConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends CronConfig>

Overrides:

config in class TaskConfig.BuilderBase<BUILDER extends CronConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends CronConfig>

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 CronConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends CronConfig>

Overrides:

config in class TaskConfig.BuilderBase<BUILDER extends CronConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends CronConfig>

Parameters:

config - configuration instance used to obtain values to update this builder

Returns:

updated builder instance

expression

public BUILDER expression(String expression)

Cron expression for specifying period of execution.

Examples:

• 0/2 * * * * ? * - Every 2 seconds
• 0 45 9 ? * * - Every day at 9:45
• 0 15 8 ? * MON-FRI - Every workday at 8:15

Parameters:

expression - cron expression

Returns:

updated builder instance

See Also:

• expression()

zone

public BUILDER zone(ZoneId zone)

Time zone to use for cron expression evaluation. Defaults to ZoneId.systemDefault().

The time zone determines when the cron expression triggers. For example, a cron expression 0 0 9 * * ? (every day at 9:00 AM) with zone America/New_York will trigger at 9:00 AM Eastern Time, regardless of the system's default time zone.

Parameters:

zone - time zone for cron expression evaluation

Returns:

updated builder instance

See Also:

• zone()

concurrentExecution

public BUILDER concurrentExecution(boolean concurrentExecution)

Allow concurrent execution if previous task didn't finish before next execution. Default value is true.

Parameters:

concurrentExecution - true for allow concurrent execution.

Returns:

updated builder instance

See Also:

• concurrentExecution()

task

public BUILDER task(ScheduledConsumer<CronInvocation> 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 CronConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends CronConfig>

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 CronConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends CronConfig>

Parameters:

serviceRegistry - service registry to use

Returns:

updated builder instance

See Also:

• serviceRegistry()

expression

public Optional<String> expression()

Cron expression for specifying period of execution.

Examples:

• 0/2 * * * * ? * - Every 2 seconds
• 0 45 9 ? * * - Every day at 9:45
• 0 15 8 ? * MON-FRI - Every workday at 8:15

Returns:

cron expression

zone

public ZoneId zone()

Time zone to use for cron expression evaluation. Defaults to ZoneId.systemDefault().

The time zone determines when the cron expression triggers. For example, a cron expression 0 0 9 * * ? (every day at 9:00 AM) with zone America/New_York will trigger at 9:00 AM Eastern Time, regardless of the system's default time zone.

Returns:

time zone for cron expression evaluation

concurrentExecution

public boolean concurrentExecution()

Allow concurrent execution if previous task didn't finish before next execution. Default value is true.

Returns:

true for allow concurrent execution.

task

public Optional<ScheduledConsumer<CronInvocation>> 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 CronConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends CronConfig>

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 CronConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends CronConfig>

Returns:

service registry to use

toString

public String toString()

Overrides:

toString in class TaskConfig.BuilderBase<BUILDER extends CronConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends CronConfig>

preBuildPrototype

protected void preBuildPrototype()

Handles providers and decorators.

Overrides:

preBuildPrototype in class TaskConfig.BuilderBase<BUILDER extends CronConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends CronConfig>

validatePrototype

protected void validatePrototype()

Validates required properties.

Overrides:

validatePrototype in class TaskConfig.BuilderBase<BUILDER extends CronConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends CronConfig>