tech.units.indriya.format

Enum UnitStyle

java.lang.Object

java.lang.Enum<UnitStyle>

tech.units.indriya.format.UnitStyle

All Implemented Interfaces:

Serializable, Comparable<UnitStyle>

public enum UnitStyle
extends Enum<UnitStyle>

Defines the different variants of unit representation.

Since:

1.0.1

Version:

2.0, February 18, 2020

Author:

Werner Keil

Enum Constant Summary

Enum Constants

Enum Constant and Description
LABEL The unit will be rendered as its label.
NAME The unit will be rendered as its name.
NAME_AND_SYMBOL The unit will be rendered as its name and symbol.
SYMBOL The unit will be rendered as its symbol.
SYMBOL_AND_LABEL The unit will be rendered as its symbol and also labeled.

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 name.

See Also:

Unit.getName()

SYMBOL

public static final UnitStyle SYMBOL

The unit will be rendered as its symbol.

See Also:

Unit.getSymbol()

LABEL

public static final UnitStyle LABEL

The unit will be rendered as its label.

See Also:

javax.measure.format.UnitFormat#label()

NAME_AND_SYMBOL

public static final UnitStyle NAME_AND_SYMBOL

The unit will be rendered as its name and symbol.

See Also:

Unit.getName(), Unit.getSymbol()

SYMBOL_AND_LABEL

public static final UnitStyle SYMBOL_AND_LABEL

The unit will be rendered as its symbol and also labeled.

See Also:

Unit.getSymbol(), javax.measure.format.UnitFormat#label()

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