org.salespointframework.quantity

Enum Metric

java.lang.Object

java.lang.Enum<Metric>

org.salespointframework.quantity.Metric

All Implemented Interfaces:

Serializable, Comparable<Metric>

public enum Metric
extends Enum<Metric>

All available metrics.

Author:

Oliver Gierke

Enum Constant Summary

Enum Constants

Enum Constant and Description
KILOGRAM
LITER
METER
SQUARE_METER
UNIT

Method Summary

Modifier and Type	Method and Description
static Metric	from(String abbreviation) Returns the Metric for the given abbreviation.
String	getAbbreviation()
List<String>	getAbbreviations()
boolean	isCompatibleWith(Metric metric) Returns whether the given Metric is
static Metric	valueOf(String name) Returns the enum constant of this type with the specified name.
static Metric[]	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

SQUARE_METER

public static final Metric SQUARE_METER

METER

public static final Metric METER

KILOGRAM

public static final Metric KILOGRAM

LITER

public static final Metric LITER

UNIT

public static final Metric UNIT

Method Detail

values

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

Returns:

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

valueOf

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

isCompatibleWith

public boolean isCompatibleWith(Metric metric)

Returns whether the given Metric is

Parameters:

metric - must not be null.

Returns:

from

public static Metric from(String abbreviation)

Returns the Metric for the given abbreviation.

Parameters:

abbreviation - must not be null.

Returns:

will never be null.

Throws:

IllegalArgumentException - if no Metric can be found for the given abbreviation.

getAbbreviation

@Generated(value="lombok")
public String getAbbreviation()

getAbbreviations

@Generated(value="lombok")
public List<String> getAbbreviations()