Package rife.engine.annotations

Enum Class FlowDirection

java.lang.Object

java.lang.Enum<FlowDirection>

rife.engine.annotations.FlowDirection

All Implemented Interfaces:

Serializable, Comparable<FlowDirection>, Constable

public enum FlowDirection
extends Enum<FlowDirection>

The flow direction that will be used by a field annotation that supports it.

Since:

1.0

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
IN	Data will only flow inwards to the field.
IN_OUT	Data will flow both inwards and onwards from the field.
OUT	Data will only flow outwards from the field.

Method Summary

Modifier and Type	Method	Description
static FlowDirection	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FlowDirection[]	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

IN

public static final FlowDirection IN

Data will only flow inwards to the field.

OUT

public static final FlowDirection OUT

Data will only flow outwards from the field.

IN_OUT

public static final FlowDirection IN_OUT

Data will flow both inwards and onwards from the field.

Method Details

values

public static FlowDirection[] 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 FlowDirection 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