Package com.storedobject.core

Class Money.List

java.lang.Object

java.util.Dictionary<Currency,Money>

java.util.Hashtable<Currency,Money>

com.storedobject.core.Money.List

All Implemented Interfaces:

Serializable, Cloneable, Map<Currency,Money>

Enclosing class:

Money

public static class Money.List
extends Hashtable<Currency,Money>

A class representing a list of currency values.

Author:

Syam

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor	Description
List()

Method Summary

Modifier and Type	Method	Description
Money.List	add(Money money)	Add a monetary value to this list.
Money.List	add(Money.List moneyList)	Add a monetary values from another list.
boolean	isZero()	Whether all entries of this list contain zeros only or not.
Money.List	negate()	Create a negated list from this list.
Money.List	subtract(Money money)	Subtract a monetary value from this list.
Money.List	subtract(Money.List moneyList)	Subtract monetary values from this list.
Money	to(Currency currency)	Get the effective monetary value in a given currency.
Money	toLocal(SystemEntity systemEntity)	Convert to a local currency value.
Money	toLocal(TransactionManager tm)	Convert to a local currency value.
String	toString()	This will return the result of toString(false).
String	toString(boolean withZeros)	Stringify.
String	toString(Predicate<Money> filter)	Stringify.

Methods inherited from class java.util.Hashtable

clear, clone, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keys, keySet, merge, put, putAll, putIfAbsent, rehash, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.lang.Object

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

Constructor Details

List

public List()

Method Details

add

public Money.List add(Money money)

Add a monetary value to this list. (If an entry for the same currency already exists, this monetary value will be added to that entry).

Parameters:

money - Money to be added.

Returns:

Self reference.

add

public Money.List add(Money.List moneyList)

Add a monetary values from another list. See add(Money).

Parameters:

moneyList - Money list to be added.

Returns:

Self reference.

subtract

public Money.List subtract(Money money)

Subtract a monetary value from this list. (If an entry for the same currency already exists, this monetary value will be subtracted from that entry).

Parameters:

money - Money to be added.

Returns:

Self reference.

subtract

public Money.List subtract(Money.List moneyList)

Subtract monetary values from this list. See subtract(Money).

Parameters:

moneyList - Money list to be subtracted.

Returns:

Self reference.

isZero

public boolean isZero()

Whether all entries of this list contain zeros only or not.

Returns:

True/false.

negate

public Money.List negate()

Create a negated list from this list.

Returns:

Negated list.

to

public Money to(Currency currency)

Get the effective monetary value in a given currency.

Parameters:

currency - Currency.

Returns:

Monetary value in the given currency.

toString

public String toString()

This will return the result of toString(false).

Overrides:

toString in class Hashtable<Currency,Money>

Returns:

Stringified value.

toString

public String toString(boolean withZeros)

Stringify. Each entry will appear in a new line.

Parameters:

withZeros - Whether to include zeros or not.

Returns:

Stringified value.

toString

public String toString(Predicate<Money> filter)

Stringify. Each entry will appear in a new line.

Parameters:

filter - Filter to apply.

Returns:

Stringified value.

toLocal

public Money toLocal(TransactionManager tm)

Convert to a local currency value.

Parameters:

tm - Transaction Manager.

Returns:

Value converted into the local currency equivalent by applying appropriate currency rate.

toLocal

public Money toLocal(SystemEntity systemEntity)

Convert to a local currency value.

Parameters:

systemEntity - System Entity.

Returns:

Value converted into the local currency equivalent by applying appropriate currency rate.