Package org.openwms.core.units.api

Enum Class MetricDimensionUnit

java.lang.Object

java.lang.Enum<MetricDimensionUnit>

org.openwms.core.units.api.MetricDimensionUnit

All Implemented Interfaces:

Serializable, Comparable<MetricDimensionUnit>, Constable, BaseUnit<MetricDimensionUnit>

public enum MetricDimensionUnit
extends Enum<MetricDimensionUnit>
implements BaseUnit<MetricDimensionUnit>

A MetricDimensionUnit.

Author:

Heiko Scherrer

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CM	Centimeters.
DM	Decimeters.
M	Meters.
MM	Millimeters.

Field Summary

Fields

Modifier and Type	Field	Description
private static MetricDimensionUnit[]	all
private BigDecimal	magnitude

Constructor Summary

Constructors

Modifier	Constructor	Description
private	MetricDimensionUnit(BigDecimal magnitude)	Create a new MetricDimensionUnit.

Method Summary

Modifier and Type	Method	Description
List<MetricDimensionUnit>	getAll()	Return all sub types of the BaseUnit.
MetricDimensionUnit	getBaseUnit()	Return the base unit type of the BaseUnit.
BigDecimal	getMagnitude()	Get the magnitude of this MetricDimensionUnit.
static MetricDimensionUnit	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MetricDimensionUnit[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.openwms.core.units.api.BaseUnit

name

Enum Constant Details

MM

public static final MetricDimensionUnit MM

Millimeters.

CM

public static final MetricDimensionUnit CM

Centimeters.

DM

public static final MetricDimensionUnit DM

Decimeters.

M

public static final MetricDimensionUnit M

Meters.

Field Details

magnitude

private BigDecimal magnitude

all

private static MetricDimensionUnit[] all

Constructor Details

MetricDimensionUnit

private MetricDimensionUnit(BigDecimal magnitude)

Create a new MetricDimensionUnit.

Parameters:

magnitude - The base unit of the MetricDimension

Method Details

values

public static MetricDimensionUnit[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static MetricDimensionUnit valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getMagnitude

public BigDecimal getMagnitude()

Get the magnitude of this MetricDimensionUnit.

Returns:

the magnitude of the MetricDimension

getAll

public List<MetricDimensionUnit> getAll()

Return all sub types of the BaseUnit.

Specified by:

getAll in interface BaseUnit<MetricDimensionUnit>

Returns:

a list of sub types

getBaseUnit

public MetricDimensionUnit getBaseUnit()

Return the base unit type of the BaseUnit.

Specified by:

getBaseUnit in interface BaseUnit<MetricDimensionUnit>

Returns:

The base unit type