Package com.singularsys.jep

Class FunctionTable

java.lang.Object

com.singularsys.jep.FunctionTable

All Implemented Interfaces:

JepComponent, Serializable

Direct Known Subclasses:

BigDecFunctionTable, CaseInsensitiveFunctionTable, NullWrappedFunctionTable, RealFunctionTable, StandardFunctionTable

public class FunctionTable
extends Object
implements JepComponent

A table holding details of the functions known to Jep. This class has no functions loaded.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<String,PostfixMathCommandI>	table

Constructor Summary

Constructors

Modifier	Constructor	Description
	FunctionTable()	Constructor with an empty map.
protected	FunctionTable(Map<String,PostfixMathCommandI> oldMap)	Constructor with a pre-specified map.

Method Summary

Modifier and Type	Method	Description
PostfixMathCommandI	addFunction(String name, PostfixMathCommandI pfmc)
void	clear()
boolean	containsKey(String key)
boolean	containsValue(PostfixMathCommandI value)
Set<Map.Entry<String,PostfixMathCommandI>>	entrySet()
PostfixMathCommandI	getFunction(String name)
JepComponent	getLightWeightInstance()	Returns this.
void	init(Jep jep)	Initialize the component.
boolean	isEmpty()
Set<String>	keySet()
PostfixMathCommandI	remove(String key)
FunctionTable	shallowCopy()	Returns a new shallow copy of this function table.
int	size()
protected Map<String,PostfixMathCommandI>	threadSafeMapCopy()	Return a copy of the internal map with the same set of functions as this one.
String	toString()
Collection<PostfixMathCommandI>	values()

Methods inherited from class java.lang.Object

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

Field Details

table

protected final Map<String,PostfixMathCommandI> table

Constructor Details

FunctionTable

public FunctionTable()

Constructor with an empty map.

FunctionTable

protected FunctionTable(Map<String,PostfixMathCommandI> oldMap)

Constructor with a pre-specified map. Subclasses should define similar constructors to allow the shallowCopy() to work.

Parameters:

oldMap - map with existing set of functions

Since:

4.0

Method Details

init

public void init(Jep jep)

Description copied from interface: JepComponent

Initialize the component. This method is called whenever a component is added to Jep. Hence, it allows components to keep track of the other components they may rely on.

Specified by:

init in interface JepComponent

Parameters:

jep - the current Jep instance

getFunction

public PostfixMathCommandI getFunction(String name)

addFunction

public PostfixMathCommandI addFunction(String name,
 PostfixMathCommandI pfmc)

clear

public void clear()

entrySet

public Set<Map.Entry<String,PostfixMathCommandI>> entrySet()

isEmpty

public boolean isEmpty()

keySet

public Set<String> keySet()

size

public int size()

values

public Collection<PostfixMathCommandI> values()

containsKey

public boolean containsKey(String key)

containsValue

public boolean containsValue(PostfixMathCommandI value)

remove

public PostfixMathCommandI remove(String key)

getLightWeightInstance

public JepComponent getLightWeightInstance()

Returns this. If any functions are not thread-safe then use shallowCopy() instead.

Specified by:

getLightWeightInstance in interface JepComponent

Returns:

this

threadSafeMapCopy

protected Map<String,PostfixMathCommandI> threadSafeMapCopy()

Return a copy of the internal map with the same set of functions as this one. If any of the pfmc's implement the JepComponent interface then that functions JepComponent.getLightWeightInstance() method will be called to return a thread safe function. This method can be combined with the FunctionTable(Map) constructor to allow subclasses to implement a thread-safe getLightWeightInstance() method.

Returns:

Since:

4.0

shallowCopy

public FunctionTable shallowCopy()

Returns a new shallow copy of this function table. Calls the threadSafeMapCopy() method to ensure the table is safe to use a separate thread. All subclasses should override this method to create a function table of the matching type. A typical implementation would be

          @Override
          public FunctionTable shallowCopy() {
              Map<String,PostfixMathCommandI> newMap = this.threadSafeMapCopy();
        return new myFunctionTable(newMap);
          }
 

using the threadSafeMapCopy() method to return a copy of the map of operators and a constructor taking this map which uses the FunctionTable(Map) constructor.

Returns:

a new shallow copy of this function table

toString

public String toString()

Overrides:

toString in class Object