Package repast.simphony.engine.schedule

Enum Class Frequency

java.lang.Object

java.lang.Enum<Frequency>

repast.simphony.engine.schedule.Frequency

All Implemented Interfaces:

Serializable, Comparable<Frequency>, java.lang.constant.Constable

public enum Frequency
extends Enum<Frequency>

An enumeration of the types of execution frequency.

Version:

$Revision: 1.1 $ $Date: 2005/12/21 22:25:34 $

Author:

Nick Collier

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AT_INTERVAL
AT_UPDATE
ON_MOVE
ON_NEW
ONE_TIME
REPEAT

Method Summary

Modifier and Type	Method	Description
static Frequency	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Frequency[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ONE_TIME

public static final Frequency ONE_TIME

REPEAT

public static final Frequency REPEAT

AT_INTERVAL

public static final Frequency AT_INTERVAL

ON_NEW

public static final Frequency ON_NEW

ON_MOVE

public static final Frequency ON_MOVE

AT_UPDATE

public static final Frequency AT_UPDATE

Method Details

values

public static Frequency[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Frequency valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null