Interface FixedRateConfig

All Superinterfaces:

Prototype.Api, Prototype.Factory<FixedRate>, TaskConfig

All Known Implementing Classes:

FixedRateConfig.BuilderBase.FixedRateConfigImpl

public interface FixedRateConfig
extends Prototype.Api, TaskConfig

Interface generated from blueprint io.helidon.scheduling.FixedRateConfigBlueprint. Please add javadoc to blueprint, as it is currently missing.

See Also:

• builder()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	FixedRateConfig.Builder	Fluent API builder for FixedRate.
static class	FixedRateConfig.BuilderBase<BUILDER extends FixedRateConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends FixedRateConfig>	Fluent API builder base for FixedRateConfig.

Method Summary

Modifier and Type	Method	Description
static FixedRateConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static FixedRateConfig.Builder	builder(FixedRateConfig instance)	Create a new fluent API builder from an existing instance.
static FixedRateConfig	create(Config config)	Create a new instance from configuration.
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.
Duration	interval()	Fixed interval between each invocation.
ScheduledConsumer<FixedRateInvocation>	task()	Task to be scheduled for execution.

Methods inherited from interface Prototype.Factory

build

Modifier and Type	Method	Description
FixedRate	build()	Create a new instance of the runtime type from this config object.

Methods inherited from interface TaskConfig

enabled, executor, id, taskManager

Modifier and Type	Method	Description
boolean	enabled()	Whether the task is enabled.
ScheduledExecutorService	executor()	Custom ScheduledExecutorService used for executing scheduled task.
Optional<String>	id()	Identification of the started task.
TaskManager	taskManager()	Task manager that will manage the created task.

Method Details

builder

static FixedRateConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static FixedRateConfig.Builder builder(FixedRateConfig instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static FixedRateConfig create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

delayBy

Duration delayBy()

Initial delay of the first invocation.

Returns:

initial delay duration

interval

Duration interval()

Fixed interval between each invocation.

Returns:

interval between each invocation

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.

Returns:

delay type

task

ScheduledConsumer<FixedRateInvocation> task()

Task to be scheduled for execution.

Returns:

scheduled for execution