Module io.helidon.scheduling

Package io.helidon.scheduling

Class FixedRateConfig.BuilderBase.FixedRateConfigImpl

java.lang.Object

io.helidon.scheduling.TaskConfig.BuilderBase.TaskConfigImpl

io.helidon.scheduling.FixedRateConfig.BuilderBase.FixedRateConfigImpl

All Implemented Interfaces:

Prototype.Api, Prototype.Factory<FixedRate>, FixedRateConfig, TaskConfig, Supplier<FixedRate>

Enclosing class:

FixedRateConfig.BuilderBase<BUILDER extends FixedRateConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends FixedRateConfig>

protected static class FixedRateConfig.BuilderBase.FixedRateConfigImpl
extends TaskConfig.BuilderBase.TaskConfigImpl
implements FixedRateConfig, Supplier<FixedRate>

Generated implementation of the prototype, can be extended by descendant prototype implementations.

Nested Class Summary

Nested classes/interfaces inherited from interface io.helidon.scheduling.FixedRateConfig

FixedRateConfig.Builder, FixedRateConfig.BuilderBase<BUILDER extends FixedRateConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends FixedRateConfig>

Nested classes/interfaces inherited from interface io.helidon.scheduling.TaskConfig

TaskConfig.Builder, TaskConfig.BuilderBase<BUILDER extends TaskConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends TaskConfig>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FixedRateConfigImpl(FixedRateConfig.BuilderBase<?,?> builder)	Create an instance providing a builder.

Method Summary

Modifier and Type	Method	Description
FixedRate	build()	Create a new instance of the runtime type from this config object.
long	delay()	Deprecated, for removal: This API element is subject to removal in a future version.
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.
boolean	equals(Object o)
FixedRate	get()
int	hashCode()
long	initialDelay()	Deprecated, for removal: This API element is subject to removal in a future version.
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.
String	toString()

Methods inherited from class io.helidon.scheduling.TaskConfig.BuilderBase.TaskConfigImpl

enabled, executor, id, taskManager

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.helidon.scheduling.TaskConfig

enabled, executor, id, taskManager

Constructor Details

FixedRateConfigImpl

protected FixedRateConfigImpl(FixedRateConfig.BuilderBase<?,?> builder)

Create an instance providing a builder.

Parameters:

builder - extending builder base of this prototype

Method Details

build

public FixedRate build()

Description copied from interface: Prototype.Factory

Create a new instance of the runtime type from this config object.

Specified by:

build in interface Prototype.Factory<FixedRate>

Returns:

new configured runtime instance

get

public FixedRate get()

Specified by:

get in interface Supplier<FixedRate>

initialDelay

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

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

Description copied from interface: FixedRateConfig

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

Specified by:

initialDelay in interface FixedRateConfig

Returns:

initial delay value

delay

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

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

Description copied from interface: FixedRateConfig

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

Specified by:

delay in interface FixedRateConfig

Returns:

delay between each invocation

timeUnit

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

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

Description copied from interface: FixedRateConfig

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

Specified by:

timeUnit in interface FixedRateConfig

Returns:

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

delayBy

public Duration delayBy()

Description copied from interface: FixedRateConfig

Initial delay of the first invocation.

Specified by:

delayBy in interface FixedRateConfig

Returns:

initial delay duration

interval

public Duration interval()

Description copied from interface: FixedRateConfig

Fixed interval between each invocation.

Specified by:

interval in interface FixedRateConfig

Returns:

interval between each invocation

delayType

public FixedRate.DelayType delayType()

Description copied from interface: FixedRateConfig

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.

Specified by:

delayType in interface FixedRateConfig

Returns:

delay type

task

public ScheduledConsumer<FixedRateInvocation> task()

Description copied from interface: FixedRateConfig

Task to be scheduled for execution.

Specified by:

task in interface FixedRateConfig

Returns:

scheduled for execution

toString

public String toString()

Overrides:

toString in class TaskConfig.BuilderBase.TaskConfigImpl

equals

public boolean equals(Object o)

Overrides:

equals in class TaskConfig.BuilderBase.TaskConfigImpl

hashCode

public int hashCode()

Overrides:

hashCode in class TaskConfig.BuilderBase.TaskConfigImpl