Package 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 Description KILOGRAM
LITER
METER
SQUARE_METER
UNIT
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Metric
from(String abbreviation)
Returns theMetric
for the given abbreviation.String
getAbbreviation()
List<String>
getAbbreviations()
boolean
isCompatibleWith(Metric metric)
Returns whether the givenMetric
isstatic 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.
-
-
-
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 nameNullPointerException
- if the argument is null
-
isCompatibleWith
public boolean isCompatibleWith(Metric metric)
Returns whether the givenMetric
is- Parameters:
metric
- must not be null.- Returns:
-
from
public static Metric from(String abbreviation)
Returns theMetric
for the given abbreviation.- Parameters:
abbreviation
- must not be null.- Returns:
- will never be null.
- Throws:
IllegalArgumentException
- if noMetric
can be found for the given abbreviation.
-
getAbbreviation
public String getAbbreviation()
-
-