io.konik.zugferd.unqualified

Class Quantity

java.lang.Object

io.konik.zugferd.unqualified.Quantity

All Implemented Interfaces:

java.io.Serializable

public class Quantity
extends java.lang.Object
implements java.io.Serializable

The Quantity

Defined by the amount and Unit

Units are based on Recommendation N°. 20 - Codes for Units of Measure Used in International Trade

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Quantity() Instantiates a new quantity.
Quantity(java.math.BigDecimal value, java.lang.String unitCode) Instantiates a new quantity.
Quantity(java.math.BigDecimal value, UnitOfMeasurement unit) Instantiates a new quantity.
Quantity(int value, java.lang.String unitCode) Instantiates a new quantity.
Quantity(int value, UnitOfMeasurement unit) Instantiates a new quantity.

Method Summary

Modifier and Type	Method and Description
UnitOfMeasurement	getUnit() Gets the unit.
java.lang.String	getUnitCode() Gets the unit code.
java.math.BigDecimal	getValue() Gets the value.
void	setUnit(UnitOfMeasurement unit) Sets the unit.
void	setUnitCode(java.lang.String newUnitCode) Sets the unit code.
Quantity	setValue(java.math.BigDecimal value) Sets the value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Quantity

public Quantity()

Instantiates a new quantity.

Quantity

public Quantity(java.math.BigDecimal value,
                java.lang.String unitCode)

Instantiates a new quantity.

Parameters:

value - the value

unitCode - the unit code

Quantity

public Quantity(java.math.BigDecimal value,
                UnitOfMeasurement unit)

Instantiates a new quantity.

Parameters:

value - the value

unit - the unit

Quantity

public Quantity(int value,
                java.lang.String unitCode)

Instantiates a new quantity.

Parameters:

value - the value

unitCode - the unit code

Quantity

public Quantity(int value,
                UnitOfMeasurement unit)

Instantiates a new quantity.

Parameters:

value - the integer value

unit - the unit

Method Detail

getUnit

public UnitOfMeasurement getUnit()

Gets the unit.

Returns:

the unit or null if unit is not known.

getUnitCode

@Size(min=1,
      max=3)
public java.lang.String getUnitCode()

Gets the unit code.

Returns:

the unit code

getValue

@NotNull
public java.math.BigDecimal getValue()

Gets the value.

Returns:

the value

setUnit

public void setUnit(UnitOfMeasurement unit)

Sets the unit.

Parameters:

unit - the new unit

setUnitCode

public void setUnitCode(java.lang.String newUnitCode)

Sets the unit code.

Parameters:

newUnitCode - the new unit code

setValue

public Quantity setValue(java.math.BigDecimal value)

Sets the value.

Parameters:

value - the new value

Returns:

the quantity