io.konik.zugferd.unqualified

Class Amount

java.lang.Object

io.konik.zugferd.unqualified.Amount

All Implemented Interfaces:

java.io.Serializable

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

The Monetary Amount.

A number of monetary units specified by a currency where the currency is explicit or implied.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Amount(java.math.BigDecimal value, com.neovisionaries.i18n.CurrencyCode currency) Instantiates a new amount.
Amount(long value, com.neovisionaries.i18n.CurrencyCode currency) Instantiates a new amount.
Amount(java.lang.String value, com.neovisionaries.i18n.CurrencyCode currency) Instantiates a new amount.

Method Summary

Modifier and Type	Method and Description
com.neovisionaries.i18n.CurrencyCode	getCurrency() Gets the currency code.
java.math.BigDecimal	getValue() Gets the amount value.
Amount	setCurrency(com.neovisionaries.i18n.CurrencyCode currency) Sets the currency code.
Amount	setValue(java.math.BigDecimal value) Sets the amount value.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Amount

public Amount(java.math.BigDecimal value,
              com.neovisionaries.i18n.CurrencyCode currency)

Instantiates a new amount.

Parameters:

value - the value

currency - the currency code

Amount

public Amount(long value,
              com.neovisionaries.i18n.CurrencyCode currency)

Instantiates a new amount.

Parameters:

value - the monetary value as a long

currency - the currency code

Amount

public Amount(java.lang.String value,
              com.neovisionaries.i18n.CurrencyCode currency)

Instantiates a new amount.

Parameters:

value - the monetary value as a string

currency - the currency code

Throws:

java.lang.NumberFormatException - if value is not a valid representation of a BigDecimal.

Method Detail

getCurrency

public com.neovisionaries.i18n.CurrencyCode getCurrency()

Gets the currency code.

Returns:

the ISO 4217 3A currency code

getValue

public java.math.BigDecimal getValue()

Gets the amount value.

Returns:

the value

setCurrency

public Amount setCurrency(com.neovisionaries.i18n.CurrencyCode currency)

Sets the currency code.

Parameters:

currency - the new ISO 4217 3A currency code

Returns:

the amount

setValue

public Amount setValue(java.math.BigDecimal value)

Sets the amount value.

Parameters:

value - the new value

Returns:

the amount

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object