net.sf.mmm.util.lang.api

Enum Direction

java.lang.Object

java.lang.Enum<Direction>

net.sf.mmm.util.lang.api.Direction

All Implemented Interfaces:

Serializable, Comparable<Direction>, AttributeReadValue<String>, Datatype, SimpleDatatype<String>, NlsObject

public enum Direction
extends Enum<Direction>
implements SimpleDatatype<String>, NlsObject

This enum contains all possible directions.

Since:

4.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Enum Constant Summary

Enum Constants

Enum Constant and Description
EAST Direction to the east (right).
NORTH Direction the the north (up/top).
NORTH_EAST Direction to the north-east (up/top and right).
NORTH_WEST Direction to the north-west (up/top and left).
SOUTH Direction to the south (down/bottom).
SOUTH_EAST Direction to the south-east (down/bottom and right).
SOUTH_WEST Direction to the south-west (down/bottom and left).
WEST Direction the the west (left).

Field Summary

Fields

Modifier and Type	Field and Description
private String	title
private String	value

Fields inherited from interface net.sf.mmm.util.nls.api.NlsObject

KEY_ANNOTATION, KEY_ARGUMENT, KEY_CAPACITY, KEY_CONTAINER, KEY_DEFAULT, KEY_DIRECTORY, KEY_ERROR, KEY_EXISTING, KEY_EXPECTED, KEY_FILE, KEY_FUNCTION, KEY_ID, KEY_KEY, KEY_LOCATION, KEY_MAX, KEY_MIN, KEY_MODE, KEY_NAME, KEY_OBJECT, KEY_OPERAND, KEY_OPERATION, KEY_OPTION, KEY_PATH, KEY_PROPERTY, KEY_QUERY, KEY_RESOURCE, KEY_SIZE, KEY_SOURCE, KEY_TARGET_TYPE, KEY_TITLE, KEY_TYPE, KEY_URI, KEY_USER, KEY_VALUE

Method Summary

Modifier and Type	Method and Description
private static NlsBundleUtilCoreRoot	getBundle()
String	getValue() This method returns the raw value of this datatype.
boolean	isToEast()
boolean	isToNorth()
boolean	isToSouth()
boolean	isToWest()
String	toString() Returns the official String representation of this Datatype.
static Direction	valueOf(String name) Returns the enum constant of this type with the specified name.
static Direction[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.sf.mmm.util.nls.api.NlsObject

toNlsMessage

Enum Constant Detail

SOUTH

public static final Direction SOUTH

Direction to the south (down/bottom).

EAST

public static final Direction EAST

Direction to the east (right).

WEST

public static final Direction WEST

Direction the the west (left).

NORTH

public static final Direction NORTH

Direction the the north (up/top).

SOUTH_EAST

public static final Direction SOUTH_EAST

Direction to the south-east (down/bottom and right).

SOUTH_WEST

public static final Direction SOUTH_WEST

Direction to the south-west (down/bottom and left).

NORTH_EAST

public static final Direction NORTH_EAST

Direction to the north-east (up/top and right).

NORTH_WEST

public static final Direction NORTH_WEST

Direction to the north-west (up/top and left).

Field Detail

value

private final String value

title

private final String title

Method Detail

values

public static Direction[] 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 (Direction c : Direction.values())
    System.out.println(c);

Returns:

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

valueOf

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

getValue

public String getValue()

Description copied from interface: SimpleDatatype

This method returns the raw value of this datatype. This will typically be a standard datatype (like String , Character, Boolean, any type of Number, any type of java.time.LocalDate, etc.).

Specified by:

getValue in interface AttributeReadValue<String>

Specified by:

getValue in interface SimpleDatatype<String>

Returns:

the value of this datatype.

toString

public String toString()

Description copied from interface: Datatype

Returns the official String representation of this Datatype. While the general contract of Object.toString() is very weak and mainly used for debugging, the contract here is very strong. The returned String has to be suitable for end-users and official output to any kind of sink.
ATTENTION:
This method is not supposed to do internationalization (I18N). See NlsMessage for this purpose and implement NlsObject if you want to support I18N/L10N.

Specified by:

toString in interface Datatype

Overrides:

toString in class Enum<Direction>

Returns:

the official String representation to display the value of this Datatype.

getBundle

private static NlsBundleUtilCoreRoot getBundle()

Returns:

the instance of NlsBundleUtilCoreRoot.

isToEast

public boolean isToEast()

Returns:

true if pointing to the east (EAST, SOUTH_EAST, or NORTH_EAST), false otherwise.

isToWest

public boolean isToWest()

Returns:

true if pointing to the west (WEST, SOUTH_WEST, or NORTH_WEST), false otherwise.

isToSouth

public boolean isToSouth()

Returns:

true if pointing to the south (SOUTH, SOUTH_EAST, or SOUTH_WEST), false otherwise.

isToNorth

public boolean isToNorth()

Returns:

true if pointing to the north (NORTH, NORTH_EAST, or NORTH_WEST), false otherwise.