org.jdtaus.banking.dtaus.spi

Class CurrencyCounter

java.lang.Object

org.jdtaus.banking.dtaus.spi.CurrencyCounter

All Implemented Interfaces:

Serializable

public class CurrencyCounter
extends Object
implements Serializable

Utility class for maintaining a mapping of currencies to corresponding counters.

Note:
This class is not synchronized and must not be used concurrently without external synchronization.

Version:

$JDTAUS: CurrencyCounter.java 8661 2012-09-27 11:29:58Z schulte $

Author:

Christian Schulte

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CurrencyCounter()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Currency currency) Adds to the counter of a currency.
Currency[]	getCurrencies() Gets the currencies for which the instance holds counters.
long	getValue(Currency currency) Gets the value of the counter for a given Currency.
void	substract(Currency currency) Substracts from the counter of a currency.

Methods inherited from class java.lang.Object

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

Constructor Detail

CurrencyCounter

public CurrencyCounter()

Method Detail

add

public void add(Currency currency)

Adds to the counter of a currency.

Parameters:

currency - The currency to add to.

Throws:

NullPointerException - if currency is null.

IndexOutOfBoundsException - if the value of the counter of currency is equal to Long.MAX_VALUE.

getCurrencies

public Currency[] getCurrencies()

Gets the currencies for which the instance holds counters.

Returns:

The currencies for which the instance holds counters.

getValue

public long getValue(Currency currency)

Gets the value of the counter for a given Currency.

Parameters:

currency - The currency to return the value of the counter for.

Returns:

The value of the counter of currency.

Throws:

NullPointerException - if currency is null.

substract

public void substract(Currency currency)

Substracts from the counter of a currency.

Parameters:

currency - The currency to substract from.

Throws:

NullPointerException - if currency is null.

IndexOutOfBoundsException - if the value of the counter of currency is equal to zero.