Package net.ssehub.easy.varModel.cst

Class VariablePool

java.lang.Object

net.ssehub.easy.varModel.cst.VariablePool

public class VariablePool
extends java.lang.Object

Utility class for caching / pooling variables in order to save memory. Please use this class local to a model / operation in order avoid that memory remains allocated although not used.

Author:

Sascha El-Sharkawy, Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field	Description
private static boolean	ENABLE
private java.util.Map<java.lang.Integer,Variable>	variablesCache

Constructor Summary

Constructors

Constructor	Description
VariablePool()

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears this pool for reuse or to force unallocation of memory.
static java.lang.Integer	keyObject(AbstractVariable decl)	Returns the key object for hashes, also for tests.
boolean	knowsVariable(AbstractVariable decl)	Returns whether this pool knows a certain variable.
Variable	obtainVariable(AbstractVariable decl)	Returns a Variable for the given AbstractVariable.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ENABLE

private static final boolean ENABLE

See Also:

Constant Field Values

variablesCache

private java.util.Map<java.lang.Integer,Variable> variablesCache

Constructor Detail

VariablePool

public VariablePool()

Method Detail

obtainVariable

public final Variable obtainVariable(AbstractVariable decl)

Returns a Variable for the given AbstractVariable. This method will cache already created Variables to reduce memory consumption.

Parameters:

decl - A AbstractVariable for which a Variable shall be created.

Returns:

A cached Variable for the given AbstractVariable or a new one if no cached variable exists, a new one is created and will be cached for future calls.

keyObject

public static final java.lang.Integer keyObject(AbstractVariable decl)

Returns the key object for hashes, also for tests. This is needed, as the equals/hashcode implementation of AbstractVariable is just based on the name and does not cope with local variables. This method shall remind dependent implementations about the aforementionied problem.

Parameters:

decl - the declaration

Returns:

the key/hash object

knowsVariable

public final boolean knowsVariable(AbstractVariable decl)

Returns whether this pool knows a certain variable.

Parameters:

decl - the variable declaration

Returns:

true if the pool knows the variable, false else

clear

public final void clear()

Clears this pool for reuse or to force unallocation of memory.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object