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 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()	Create a new instance with default values.
static FixedRateConfig	create(Config config)	Deprecated. use create(io.helidon.config.Config)
static FixedRateConfig	create(Config config)	Create a new instance from configuration.
long	delay()	Deprecated, for removal: This API element is subject to removal in a future version. This option is deprecated, use interval() instead
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.
long	initialDelay()	Deprecated, for removal: This API element is subject to removal in a future version. This option is deprecated, use delayBy() instead
Duration	interval()	Fixed interval between each invocation.
ScheduledConsumer<FixedRateInvocation>	task()	Task to be scheduled for execution.
TimeUnit	timeUnit()	Deprecated, for removal: This API element is subject to removal in a future version. as duration is used for new options, this option is not needed

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

build

Methods inherited from interface io.helidon.scheduling.TaskConfig

enabled, executor, id, taskManager

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

create

@Deprecated
static FixedRateConfig create(Config config)

Deprecated.

use create(io.helidon.config.Config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

static FixedRateConfig create()

Create a new instance with default values.

Returns:

a new instance

initialDelay

@Deprecated(since="4.2.0",
            forRemoval=true)
long initialDelay()

Deprecated, for removal: This API element is subject to removal in a future version.

This option is deprecated, use delayBy() instead

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

Returns:

initial delay value

delay

@Deprecated(since="4.2.0",
            forRemoval=true)
long delay()

Deprecated, for removal: This API element is subject to removal in a future version.

This option is deprecated, use interval() instead

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

timeUnit

@Deprecated(since="4.2.0",
            forRemoval=true)
TimeUnit timeUnit()

Deprecated, for removal: This API element is subject to removal in a future version.

as duration is used for new options, this option is not needed

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)

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