Package org.openwms.core.units.api

Class Piece

java.lang.Object

org.openwms.core.units.api.Piece

All Implemented Interfaces:

Serializable, Comparable<Piece>, Measurable<BigDecimal,Piece,PieceUnit>

public class Piece
extends Object
implements Measurable<BigDecimal,Piece,PieceUnit>, Serializable

A Piece.

Author:

Heiko Scherrer

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private BigDecimal	magnitude	The magnitude of the Piece.
private static final BigDecimal	SHIFTER
private PieceUnit	unitType	The unit of the Piece.
static final Piece	ZERO	Constant for a zero value.

Fields inherited from interface org.openwms.core.units.api.Measurable

SEPARATOR

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Piece()	Accessed by persistence provider.
private	Piece(BigDecimal magnitude, PieceUnit unitType)	Create a new Piece.

Method Summary

Modifier and Type	Method	Description
Measurable<BigDecimal,Piece,PieceUnit>	add(Measurable<BigDecimal,Piece,PieceUnit> other)	Add an other Measurable to this one.
private int	compare(BigDecimal val1, BigDecimal val2)
int	compareTo(Piece o)
Piece	convertTo(PieceUnit unt)	Convert this Measurable into another Measurable .
boolean	equals(Object obj)	Uses magnitude and unitType for comparison.
BigDecimal	getMagnitude()	Get the magnitude of this Measurable.
PieceUnit	getUnitType()	Returns the type of Measurable.
int	hashCode()	Uses magnitude and unitType for calculation.
boolean	isNegative()	Check whether the magnitude is of negative value.
boolean	isZero()	Check whether the magnitude is 0.
static Piece	of(int magnitude)	Create a new Piece.
static Piece	of(int magnitude, PieceUnit unitType)	Create a new Piece.
static Piece	of(BigDecimal magnitude)	Create a new Piece.
static Piece	of(BigDecimal magnitude, PieceUnit unitType)	Create a new Piece.
Measurable<BigDecimal,Piece,PieceUnit>	subtract(Measurable<BigDecimal,Piece,PieceUnit> subtrahent)	Subtract an other Measurable instance from this one.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

asString

Field Details

SHIFTER

private static final BigDecimal SHIFTER

unitType

private PieceUnit unitType

The unit of the Piece.

magnitude

private BigDecimal magnitude

The magnitude of the Piece.

ZERO

public static final Piece ZERO

Constant for a zero value.

Constructor Details

Piece

protected Piece()

Accessed by persistence provider.

Piece

private Piece(BigDecimal magnitude,
 PieceUnit unitType)

Create a new Piece.

Parameters:

magnitude - The magnitude

unitType - The unit of measure

Method Details

of

public static Piece of(int magnitude,
 PieceUnit unitType)

Create a new Piece.

Parameters:

magnitude - The magnitude

unitType - The unit of measure

Returns:

The new instance

of

public static Piece of(int magnitude)

Create a new Piece.

Parameters:

magnitude - The magnitude

Returns:

The new instance

of

public static Piece of(BigDecimal magnitude,
 PieceUnit unitType)

Create a new Piece.

Parameters:

magnitude - The magnitude

unitType - The unit of measure

Returns:

The new instance

of

public static Piece of(BigDecimal magnitude)

Create a new Piece.

Parameters:

magnitude - The magnitude

Returns:

The new instance

getMagnitude

public BigDecimal getMagnitude()

Get the magnitude of this Measurable.

Specified by:

getMagnitude in interface Measurable<BigDecimal,Piece,PieceUnit>

Returns:

the magnitude

getUnitType

public PieceUnit getUnitType()

Returns the type of Measurable.

Specified by:

getUnitType in interface Measurable<BigDecimal,Piece,PieceUnit>

Returns:

The Measurable's type

isZero

public boolean isZero()

Check whether the magnitude is 0.

Specified by:

isZero in interface Measurable<BigDecimal,Piece,PieceUnit>

Returns:

true is magnitude is 0, otherwise false

isNegative

public boolean isNegative()

Check whether the magnitude is of negative value.

Specified by:

isNegative in interface Measurable<BigDecimal,Piece,PieceUnit>

Returns:

true if the magnitude is of negative value, otherwise false

convertTo

public Piece convertTo(PieceUnit unt)

Convert this Measurable into another Measurable .

Specified by:

convertTo in interface Measurable<BigDecimal,Piece,PieceUnit>

Parameters:

unt - The BaseUnit to convert to

Returns:

The converted unit

add

public Measurable<BigDecimal,Piece,PieceUnit> add(Measurable<BigDecimal,Piece,PieceUnit> other)

Add an other Measurable to this one.

Specified by:

add in interface Measurable<BigDecimal,Piece,PieceUnit>

Parameters:

other - The one to add

Returns:

A new instance

toString

public String toString()

Overrides:

toString in class Object

subtract

public Measurable<BigDecimal,Piece,PieceUnit> subtract(Measurable<BigDecimal,Piece,PieceUnit> subtrahent)

Subtract an other Measurable instance from this one.

Specified by:

subtract in interface Measurable<BigDecimal,Piece,PieceUnit>

Parameters:

subtrahent - The one to subtract

Returns:

A new instance

compareTo

public int compareTo(Piece o)

Specified by:

compareTo in interface Comparable<Piece>

hashCode

public int hashCode()

Uses magnitude and unitType for calculation.

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Uses magnitude and unitType for comparison.

Overrides:

equals in class Object

compare

private int compare(BigDecimal val1,
 BigDecimal val2)