de.skuzzle.inject.async.annotation

Enum SimpleScheduleType

java.lang.Object

java.lang.Enum<SimpleScheduleType>

de.skuzzle.inject.async.annotation.SimpleScheduleType

All Implemented Interfaces:

Serializable, Comparable<SimpleScheduleType>

public enum SimpleScheduleType
extends Enum<SimpleScheduleType>

Defines the way in which a method annotated with SimpleTrigger is scheduled with a ScheduledExecutorService.

Author:

Simon Taddiken

Enum Constant Summary

Enum Constants

Enum Constant and Description
AT_FIXED_RATE Used to schedule a command using ScheduledExecutorService.scheduleAtFixedRate(Runnable, long, long, TimeUnit) .
WITH_FIXED_DELAY Used to schedule a command using ScheduledExecutorService.scheduleAtFixedRate(Runnable, long, long, TimeUnit)

Method Summary

Modifier and Type	Method and Description
abstract ScheduledFuture<?>	schedule(ScheduledExecutorService scheduler, Runnable command, long initialDelay, long rate, TimeUnit unit) Schedules a Runnable according to this scheduling type.
static SimpleScheduleType	valueOf(String name) Returns the enum constant of this type with the specified name.
static SimpleScheduleType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AT_FIXED_RATE

public static final SimpleScheduleType AT_FIXED_RATE

Used to schedule a command using ScheduledExecutorService.scheduleAtFixedRate(Runnable, long, long, TimeUnit) .

WITH_FIXED_DELAY

public static final SimpleScheduleType WITH_FIXED_DELAY

Used to schedule a command using ScheduledExecutorService.scheduleAtFixedRate(Runnable, long, long, TimeUnit)

Method Detail

values

public static SimpleScheduleType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SimpleScheduleType c : SimpleScheduleType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SimpleScheduleType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

schedule

public abstract ScheduledFuture<?> schedule(ScheduledExecutorService scheduler,
                                            Runnable command,
                                            long initialDelay,
                                            long rate,
                                            TimeUnit unit)

Schedules a Runnable according to this scheduling type.

Parameters:

scheduler - The scheduler to schedule the command with.

command - The command to schedule.

initialDelay - The initial delay.

rate - The scheduling rate.

unit - Time unit in which rate and delay are interpreted.

Returns:

The future object.