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>, Prototype.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 Prototype.ConfiguredBuilder<BUILDER,PROTOTYPE>

Fluent API builder base for Cron.

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.
Optional<Config>	config()	If this instance was configured, this would be the config instance used.
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<ScheduledConsumer<CronInvocation>>	task()	Task to be scheduled for execution.
BUILDER	task(ScheduledConsumer<CronInvocation> task)	Task to be scheduled for execution.
String	toString()
protected void	validatePrototype()	Validates required properties.

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

executor, executor, from, from

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

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

discoverService, discoverServices

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.

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

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

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

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:

the expression

concurrentExecution

public boolean concurrentExecution()

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

Returns:

the concurrent execution

task

public Optional<ScheduledConsumer<CronInvocation>> task()

Task to be scheduled for execution.

Returns:

the task

config

public Optional<Config> config()

If this instance was configured, this would be the config instance used.

Overrides:

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

Returns:

config node used to configure this builder, or empty if not configured

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>