repicea.simulation.processsystem

Class AmountMap<E extends java.lang.Enum<?>>

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<E,java.lang.Double>

repicea.simulation.processsystem.AmountMap<E>

Type Parameters:

E - an Enum class

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<E,java.lang.Double>

public class AmountMap<E extends java.lang.Enum<?>>
extends java.util.HashMap<E,java.lang.Double>
implements java.lang.Cloneable

The AmountMap class contains all the quantities that can be contained in a ProcessUnit instance.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

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

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
AmountMap()

Method Summary

Modifier and Type	Method and Description
void	add(E key, double amount) This method add a particular amount in a key.
AmountMap<E>	clone()
AmountMap<E>	multiplyByAScalar(double scalar) This method multiplies all the values in the current instance by a scalar.
void	putAll(java.util.Map<? extends E,? extends java.lang.Double> map)
static void	scaleMap(java.util.Map oMap, double scalar) This method scales the AmountMap instances contained in more complex Map instances.

Methods inherited from class java.util.HashMap

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

AmountMap

public AmountMap()

Method Detail

putAll

public void putAll(java.util.Map<? extends E,? extends java.lang.Double> map)

Specified by:

putAll in interface java.util.Map<E extends java.lang.Enum<?>,java.lang.Double>

Overrides:

putAll in class java.util.HashMap<E extends java.lang.Enum<?>,java.lang.Double>

add

public void add(E key,
                double amount)

This method add a particular amount in a key.

Parameters:

key -

amount -

multiplyByAScalar

public AmountMap<E> multiplyByAScalar(double scalar)

This method multiplies all the values in the current instance by a scalar.

Parameters:

scalar - the multiplicative factor

Returns:

a new AmountMap instance with updated values

clone

public AmountMap<E> clone()

Overrides:

clone in class java.util.HashMap<E extends java.lang.Enum<?>,java.lang.Double>

scaleMap

public static void scaleMap(java.util.Map oMap,
                            double scalar)

This method scales the AmountMap instances contained in more complex Map instances. It is recursive. IMPORTANT: the original map is changed. This avoid creating new instances which raise an exception when the Map class does not have any empty constructor.

Parameters:

oMap -

scalar - the multiplier factor