Interface FixedRate

All Superinterfaces:

RuntimeType.Api<FixedRateConfig>, Task

public interface FixedRate
extends RuntimeType.Api<FixedRateConfig>, Task

Scheduling periodically executed task with specified fixed rate.

FixedRate.builder()
     .interval(Duration.ofSeconds(2))
     .task(inv -> System.out.println("Executed every 2 seconds"))
     .build();

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	FixedRate.DelayType	Whether the interval of the next invocation should be calculated from the start or end of the previous task.

Method Summary

Static Methods

Modifier and Type	Method	Description
static FixedRateConfig.Builder	builder()	Create a new fluent API builder to build a fixed rate task.
static FixedRate	create(FixedRateConfig config)	Create a fixed rate task from programmatic configuration.
static FixedRate	create(Consumer<FixedRateConfig.Builder> configConsumer)	Create a fixed rate task from configuration.

Methods inherited from interface RuntimeType.Api

prototype

Modifier and Type	Method	Description
FixedRateConfig	prototype()	The prototype as it was received when creating this runtime object instance.

Methods inherited from interface Task

close, description, enabled, executor, id

Modifier and Type	Method	Description
default void	close()	Close the created task.
String	description()	Human-readable description of the task invocation interval.
default boolean	enabled()	If task is enabled or disabled, scheduling tasks are enabled by default and can be disabled programmatically or via configuration.
ScheduledExecutorService	executor()	Executor used for invocation of scheduled tasks.
default String	id()	ID used to identify this task.

Method Details

builder

static FixedRateConfig.Builder builder()

Create a new fluent API builder to build a fixed rate task.

Returns:

a builder instance

create

static FixedRate create(Consumer<FixedRateConfig.Builder> configConsumer)

Create a fixed rate task from configuration.

Parameters:

configConsumer - config consumer

Returns:

a new fixed rate task configured from config

create

static FixedRate create(FixedRateConfig config)

Create a fixed rate task from programmatic configuration.

Parameters:

config - configuration

Returns:

a new fixed rate task