tech.uom.impl.enums.format

Enum UnitStyle

java.lang.Object

java.lang.Enum<UnitStyle>

tech.uom.impl.enums.format.UnitStyle

All Implemented Interfaces:

Serializable, Comparable<UnitStyle>

public enum UnitStyle
extends Enum<UnitStyle>

Defines the different variants of unit formatting.

Author:

Werner Keil

Enum Constant Summary

Enum Constants

Enum Constant and Description
NAME The unit will be rendered as its localized display name.
SYMBOL The unit will be rendered as its (non localized) unit symbol.

Method Summary

Modifier and Type	Method and Description
static UnitStyle	valueOf(String name) Returns the enum constant of this type with the specified name.
static UnitStyle[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NAME

public static final UnitStyle NAME

The unit will be rendered as its localized display name. If no display name is known for the required Unit, the unit symbol should be used as a fall-back.

See Also:

Unit.getName()

SYMBOL

public static final UnitStyle SYMBOL

The unit will be rendered as its (non localized) unit symbol.

See Also:

Unit.getSymbol()

Method Detail

values

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

Returns:

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

valueOf

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