Package org.gcube.informationsystem.base.reference

Enum Class Direction

java.lang.Object

java.lang.Enum<Direction>

org.gcube.informationsystem.base.reference.Direction

All Implemented Interfaces:

Serializable, Comparable<Direction>, Constable

public enum Direction
extends Enum<Direction>

Specifies the direction of a relationship or flow.

Author:

Luca Frosini (ISTI - CNR)

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
BOTH	Indicates a bidirectional flow.
IN	Indicates an inward direction.
OUT	Indicates an outward direction.

Method Summary

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

Indicates an inward direction.

OUT

public static final Direction OUT

Indicates an outward direction.

BOTH

public static final Direction BOTH

Indicates a bidirectional flow.

Method Details

values

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

opposite

public Direction opposite()

Returns the opposing direction.

- IN becomes OUT.

- OUT becomes IN.

- BOTH remains BOTH.

Returns:

The opposite direction.