Package org.openwms.core.units.api

Enum Class PieceUnit

java.lang.Object

java.lang.Enum<PieceUnit>

org.openwms.core.units.api.PieceUnit

All Implemented Interfaces:

Serializable, Comparable<PieceUnit>, Constable, BaseUnit<PieceUnit>

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

A PieceUnit.

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
DOZ	A Dozen.
PC	A Piece.

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
List<PieceUnit>	getAll()	Return all sub types of the BaseUnit.
PieceUnit	getBaseUnit()	Return the base unit type of the BaseUnit.
BigDecimal	getMagnitude()	Get the magnitude of this PieceUnit.
static PieceUnit	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PieceUnit[]	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

PC

public static final PieceUnit PC

A Piece.

DOZ

public static final PieceUnit DOZ

A Dozen.

Field Details

magnitude

private final BigDecimal magnitude

all

private static final PieceUnit[] all

Constructor Details

PieceUnit

private PieceUnit(BigDecimal magnitude)

Create a new PieceUnit.

Parameters:

magnitude - The base unit of the PieceUnit

Method Details

values

public static PieceUnit[] 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 PieceUnit 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 PieceUnit.

Returns:

the magnitude

getAll

public List<PieceUnit> getAll()

Return all sub types of the BaseUnit.

Specified by:

getAll in interface BaseUnit<PieceUnit>

Returns:

a list of sub types

getBaseUnit

public PieceUnit getBaseUnit()

Return the base unit type of the BaseUnit.

Specified by:

getBaseUnit in interface BaseUnit<PieceUnit>

Returns:

The base unit type