Package org.openwms.core.units.api

Class MetricDimension

java.lang.Object

org.openwms.core.units.api.MetricDimension

All Implemented Interfaces:

Serializable, Comparable<MetricDimension>, Measurable<BigDecimal,MetricDimension,MetricDimensionUnit>

public class MetricDimension
extends Object
implements Measurable<BigDecimal,MetricDimension,MetricDimensionUnit>, Serializable

A MetricDimension represents metric dimensional units, like meters.

Author:

Heiko Scherrer

See Also:

• Serialized Form

Field Summary

Fields

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

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

SEPARATOR

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Measurable<BigDecimal,MetricDimension,MetricDimensionUnit>	add(Measurable<BigDecimal,MetricDimension,MetricDimensionUnit> other)	Add an other Measurable to this one.
int	compareTo(MetricDimension o)
MetricDimension	convertTo(MetricDimensionUnit 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.
MetricDimensionUnit	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 MetricDimension	of(int magnitude)	Create a new MetricDimension.
static MetricDimension	of(int magnitude, MetricDimensionUnit unitType)	Create a new MetricDimension.
static MetricDimension	of(BigDecimal magnitude)	Create a new MetricDimension.
static MetricDimension	of(BigDecimal magnitude, MetricDimensionUnit unitType)	Create a new MetricDimension.
Measurable<BigDecimal,MetricDimension,MetricDimensionUnit>	subtract(Measurable<BigDecimal,MetricDimension,MetricDimensionUnit> 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

unitType

private MetricDimensionUnit unitType

The unit of the MetricDimension.

magnitude

private BigDecimal magnitude

The magnitude of the MetricDimensionUnit.

ZERO

public static final MetricDimension ZERO

Constant for a zero value.

Constructor Details

MetricDimension

protected MetricDimension()

Accessed by persistence provider.

MetricDimension

private MetricDimension(BigDecimal magnitude,
 MetricDimensionUnit unitType)

Create a new MetricDimension.

Parameters:

magnitude - The magnitude

unitType - The unit of measure

Method Details

of

public static MetricDimension of(int magnitude,
 MetricDimensionUnit unitType)

Create a new MetricDimension.

Parameters:

magnitude - The magnitude

unitType - The unit of measure

Returns:

The new instance

of

public static MetricDimension of(int magnitude)

Create a new MetricDimension.

Parameters:

magnitude - The magnitude

Returns:

The new instance

of

public static MetricDimension of(BigDecimal magnitude,
 MetricDimensionUnit unitType)

Create a new MetricDimension.

Parameters:

magnitude - The magnitude

unitType - The unit of measure

Returns:

The new instance

of

public static MetricDimension of(BigDecimal magnitude)

Create a new MetricDimension.

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,MetricDimension,MetricDimensionUnit>

Returns:

the magnitude

getUnitType

public MetricDimensionUnit getUnitType()

Returns the type of Measurable.

Specified by:

getUnitType in interface Measurable<BigDecimal,MetricDimension,MetricDimensionUnit>

Returns:

The Measurable's type

isZero

public boolean isZero()

Check whether the magnitude is 0.

Specified by:

isZero in interface Measurable<BigDecimal,MetricDimension,MetricDimensionUnit>

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,MetricDimension,MetricDimensionUnit>

Returns:

true if the magnitude is of negative value, otherwise false

convertTo

public MetricDimension convertTo(MetricDimensionUnit unt)

Convert this Measurable into another Measurable .

Specified by:

convertTo in interface Measurable<BigDecimal,MetricDimension,MetricDimensionUnit>

Parameters:

unt - The BaseUnit to convert to

Returns:

The converted unit

add

public Measurable<BigDecimal,MetricDimension,MetricDimensionUnit> add(Measurable<BigDecimal,MetricDimension,MetricDimensionUnit> other)

Add an other Measurable to this one.

Specified by:

add in interface Measurable<BigDecimal,MetricDimension,MetricDimensionUnit>

Parameters:

other - The one to add

Returns:

A new instance

subtract

public Measurable<BigDecimal,MetricDimension,MetricDimensionUnit> subtract(Measurable<BigDecimal,MetricDimension,MetricDimensionUnit> subtrahent)

Subtract an other Measurable instance from this one.

Specified by:

subtract in interface Measurable<BigDecimal,MetricDimension,MetricDimensionUnit>

Parameters:

subtrahent - The one to subtract

Returns:

A new instance

compareTo

public int compareTo(MetricDimension o)

Specified by:

compareTo in interface Comparable<MetricDimension>

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

toString

public String toString()

Overrides:

toString in class Object