de.skuzzle.inject.async.annotation

Annotation Type SimpleTrigger

@Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface SimpleTrigger

A trigger annotation that allows to define a simple periodicity for method execution.

Author:

Simon Taddiken

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
long	value The period (in case of fixed rate scheduling) resp. the delay (in case of fixed delay scheduling).

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
long	initialDelay The initial delay to wait before first execution of the annotated method.
SimpleScheduleType	scheduleType Defines the way in which the execution is scheduled at a ScheduledExecutorService implementation.
TimeUnit	timeUnit The time unit in which the value() and initialDelay() fields are interpreted.

Element Detail

value

public abstract long value

The period (in case of fixed rate scheduling) resp. the delay (in case of fixed delay scheduling). By default, this value is interpreted as milliseconds. You can change this by additionally supplying the timeUnit() field.

Returns:

The period/delay that will be used for scheduling.

timeUnit

public abstract TimeUnit timeUnit

The time unit in which the value() and initialDelay() fields are interpreted. Defaults to milliseconds.

Returns:

The time unit.

Default:

java.util.concurrent.TimeUnit.MILLISECONDS

initialDelay

public abstract long initialDelay

The initial delay to wait before first execution of the annotated method. the delay applies to the time at which a type containing a scheduled method is constructed by the Injector. By default, this value is interpreted as milliseconds. You can change this by additionally supplying the timeUnit() field.

Returns:

The initial delay.

Default:

0L

scheduleType

public abstract SimpleScheduleType scheduleType

Defines the way in which the execution is scheduled at a ScheduledExecutorService implementation.

Returns:

The scheduling type.

Default:

de.skuzzle.inject.async.annotation.SimpleScheduleType.AT_FIXED_RATE