Module io.helidon.scheduling

Package io.helidon.scheduling

Class Scheduling.FixedRateBuilder

java.lang.Object

io.helidon.scheduling.Scheduling.FixedRateBuilder

All Implemented Interfaces:

Builder<Scheduling.FixedRateBuilder,Task>, Supplier<Task>

Enclosing class:

Scheduling

public static final class Scheduling.FixedRateBuilder
extends Object
implements Builder<Scheduling.FixedRateBuilder,Task>

Builder for task executed periodically at a fixed rate.

Method Summary

Modifier and Type	Method	Description
Task	build()	Build the instance from this builder.
Scheduling.FixedRateBuilder	delay(long delay)	Fixed rate delay between each invocation.
Scheduling.FixedRateBuilder	executor(ScheduledExecutorService executorService)	Custom ScheduledExecutorService used for executing scheduled task.
Scheduling.FixedRateBuilder	initialDelay(long initialDelay)	Initial delay of the first invocation.
Scheduling.FixedRateBuilder	task(ScheduledConsumer<FixedRateInvocation> task)	Task to be scheduled for execution.
Scheduling.FixedRateBuilder	timeUnit(TimeUnit timeUnit)	TimeUnit used for interpretation of values provided with delay(long) and initialDelay(long).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.helidon.common.Builder

get, identity, update

Method Details

executor

public Scheduling.FixedRateBuilder executor(ScheduledExecutorService executorService)

Custom ScheduledExecutorService used for executing scheduled task.

Parameters:

executorService - custom ScheduledExecutorService

Returns:

this builder

initialDelay

public Scheduling.FixedRateBuilder initialDelay(long initialDelay)

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

Parameters:

initialDelay - initial delay value

Returns:

this builder

delay

public Scheduling.FixedRateBuilder delay(long delay)

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

Parameters:

delay - delay between each invocation

Returns:

this builder

task

public Scheduling.FixedRateBuilder task(ScheduledConsumer<FixedRateInvocation> task)

Task to be scheduled for execution.

Parameters:

task - scheduled for execution

Returns:

this builder

timeUnit

public Scheduling.FixedRateBuilder timeUnit(TimeUnit timeUnit)

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

Parameters:

timeUnit - for interpreting delay and in delay(long) and initialDelay(long)

Returns:

this builder

build

public Task build()

Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<Scheduling.FixedRateBuilder,Task>

Returns:

instance of the built type