net.sf.mmm.util.lang.api

Enum Orientation

java.lang.Object

java.lang.Enum<Orientation>

net.sf.mmm.util.lang.api.Orientation

All Implemented Interfaces:

Serializable, Comparable<Orientation>, AttributeReadValue<String>, Datatype, SimpleDatatype<String>

public enum Orientation
extends Enum<Orientation>
implements SimpleDatatype<String>

This enum contains the available values for the orientation.

Since:

3.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

Alignment

Enum Constant Summary

Enum Constants

Enum Constant and Description
HORIZONTAL A horizontal orientation means that objects are ordered from the left to the right.
VERTICAL A vertical orientation means that objects are ordered from the top to the bottom.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
static Orientation	fromValue(String value) This method gets the Orientation with the given value.
Orientation	getMirrored() This method gets the inverse orientation.
String	getValue() This method returns the raw value of this datatype.
String	toString() Returns the official String representation of this Datatype.
static Orientation	valueOf(String name) Returns the enum constant of this type with the specified name.
static Orientation[]	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

Enum Constant Detail

HORIZONTAL

public static final Orientation HORIZONTAL

A horizontal orientation means that objects are ordered from the left to the right.

VERTICAL

public static final Orientation VERTICAL

A vertical orientation means that objects are ordered from the top to the bottom.

Field Detail

value

private final String value

See Also:

getValue()

title

private final String title

See Also:

toString()

Method Detail

values

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

Returns:

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

valueOf

public static Orientation 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()

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()

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<Orientation>

Returns:

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

fromValue

public static Orientation fromValue(String value)

This method gets the Orientation with the given value.

Parameters:

value - is the value of the requested Orientation.

Returns:

the requested Orientation.

getMirrored

public Orientation getMirrored()

This method gets the inverse orientation.

Returns:

VERTICAL if this orientation is HORIZONTAL and vice versa.