Interface Cron

All Superinterfaces:

RuntimeType.Api<CronConfig>, Task

public interface Cron
extends RuntimeType.Api<CronConfig>, Task

Scheduling periodically executed task with specified cron expression.

Cron.builder()
     .expression("0 45 9 ? * *")
     .task(inv -> System.out.println("Executed every day at 9:45"))
     .build();

Method Summary

Static Methods

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

Methods inherited from interface RuntimeType.Api

prototype

Modifier and Type	Method	Description
CronConfig	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 CronConfig.Builder builder()

Create a new fluent API builder to build a cron task.

Returns:

a builder instance

create

static Cron create(Consumer<CronConfig.Builder> configConsumer)

Create a cron task from configuration.

Parameters:

configConsumer - config consumer

Returns:

a new cron task configured from config

create

static Cron create(CronConfig config)

Create a cron task from programmatic configuration.

Parameters:

config - configuration

Returns:

a new cron task