Package org.aksw.commons.util.direction

Enum Class Direction

java.lang.Object

java.lang.Enum<Direction>

org.aksw.commons.util.direction.Direction

All Implemented Interfaces:

Serializable, Comparable<Direction>, Constable

public enum Direction
extends Enum<Direction>

An enumeration for representing forward and backward directions. Booleans quickly become confusing.

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
BACKWARD
FORWARD

Method Summary

Modifier and Type	Method	Description
boolean	isBackward()
boolean	isForward()
static Direction	ofFwd(boolean isFwd)
Direction	opposite()	Return the opposite direction - forward becomes backward and vice versa.
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

FORWARD

public static final Direction FORWARD

BACKWARD

public static final Direction BACKWARD

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

isForward

public boolean isForward()

isBackward

public boolean isBackward()

ofFwd

public static Direction ofFwd(boolean isFwd)

opposite

public Direction opposite()

Return the opposite direction - forward becomes backward and vice versa.