net.sf.mmm.util.lang.api

Enum HorizontalAlignment

java.lang.Object

java.lang.Enum<HorizontalAlignment>

net.sf.mmm.util.lang.api.HorizontalAlignment

All Implemented Interfaces:

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

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

This enum represents a horizontal alignment (e.g. for Justification).
The following table gives an example to illustrate the expected behavior of according to an HorizontalAlignment.

Alignment	Text
LEFT	Hello
CENTER	Hello
RIGHT	Hello

Since:

2.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Enum Constant Summary

Enum Constants

Enum Constant and Description
CENTER Align content centered to the middle (same space to the left and the right).
LEFT Align content to the left side.
RIGHT Align content to the right side.

Field Summary

Fields

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

Method Summary

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

LEFT

public static final HorizontalAlignment LEFT

Align content to the left side.

RIGHT

public static final HorizontalAlignment RIGHT

Align content to the right side.

CENTER

public static final HorizontalAlignment CENTER

Align content centered to the middle (same space to the left and the right).

Field Detail

value

private final String value

See Also:

getValue()

title

private final String title

See Also:

toString()

Method Detail

values

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

Returns:

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

valueOf

public static HorizontalAlignment 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.

getAlignment

public Alignment getAlignment()

This method gets the corresponding Alignment.

Returns:

the corresponding Alignment.

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

Returns:

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

fromValue

public static HorizontalAlignment fromValue(String value)

This method gets the HorizontalAlignment with the given value.

Parameters:

value - is the value of the requested HorizontalAlignment.

Returns:

the requested HorizontalAlignment.