Module io.helidon.scheduling

Package io.helidon.scheduling

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 definition. Please add javadoc to the definition interface.

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 FixedRate.

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.
long	delay()	Fixed rate delay between each invocation.
FixedRate.DelayType	delayType()	Configure whether the delay between the invocations should be calculated from the time when previous task started or ended.
ScheduledExecutorService	executor()	Custom ScheduledExecutorService used for executing scheduled task.
long	initialDelay()	Initial delay of the first invocation.
ScheduledConsumer<FixedRateInvocation>	task()	Task to be scheduled for execution.
TimeUnit	timeUnit()	TimeUnit used for interpretation of values provided with FixedRateConfig.BuilderBase.delay(long) and FixedRateConfig.BuilderBase.initialDelay(long).

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

build

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

initialDelay

long initialDelay()

Initial delay of the first invocation. Time unit is by default TimeUnit.SECONDS, can be specified with timeUnit().

Returns:

initial delay value

delay

long delay()

Fixed rate delay between each invocation. Time unit is by default TimeUnit.SECONDS, can be specified with FixedRateConfig.BuilderBase.timeUnit(java.util.concurrent.TimeUnit).

Returns:

delay between each invocation

delayType

FixedRate.DelayType delayType()

Configure whether the delay 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

timeUnit

TimeUnit timeUnit()

TimeUnit used for interpretation of values provided with FixedRateConfig.BuilderBase.delay(long) and FixedRateConfig.BuilderBase.initialDelay(long).

Returns:

time unit for interpreting values in FixedRateConfig.BuilderBase.delay(long) and FixedRateConfig.BuilderBase.initialDelay(long)

executor

ScheduledExecutorService executor()

Custom ScheduledExecutorService used for executing scheduled task.

Returns:

custom ScheduledExecutorService