Package com.singularsys.jep.misc.dictionary

Class Remove

java.lang.Object

com.singularsys.jep.functions.PostfixMathCommand

com.singularsys.jep.functions.BinaryFunction

com.singularsys.jep.misc.dictionary.Remove

All Implemented Interfaces:

PostfixMathCommandI, Serializable

public class Remove
extends BinaryFunction

Removes entries with matching key from the map.

map = {'x':2, 'y':3};
remove(map, 'x');

The function returns either the value or the removed key or nullValue if the key is missing the key has no value.

Since:

Jep 4.1

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.singularsys.jep.functions.BinaryFunction

BinaryFunction.BiFunctionWithException<T>

Field Summary

Fields

Modifier and Type	Field	Description
final Object	nullValue

Fields inherited from class com.singularsys.jep.functions.PostfixMathCommand

curNumberOfParameters, description, name, NaN, numberOfParameters

Constructor Summary

Constructors

Constructor	Description
Remove(Object nullValue)	Constructor

Method Summary

Modifier and Type	Method	Description
protected boolean	equals(Object key, Object k)	Test if key equals k.
Object	eval(Object l, Object key)	Evaluate the function
protected Object	eval(List<Object> list, Object key)
protected Object	eval(Map<Object,Object> map, Object key)

Methods inherited from class com.singularsys.jep.functions.BinaryFunction

instanceOf, instanceOf, instanceOf, instanceOf, run

Methods inherited from class com.singularsys.jep.functions.PostfixMathCommand

asArray, asBool, asDouble, asInt, asLong, asStrictInt, asString, asType, checkNumberOfParameters, getDescription, getDescription, getDescriptionWithType, getName, getNumberOfParameters, setCurNumberOfParameters, setDescription, setName, toString, toString

Methods inherited from class java.lang.Object

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

Field Details

nullValue

public final Object nullValue

Constructor Details

Remove

public Remove(Object nullValue)

Constructor

Parameters:

nullValue - , value returned when a key has no value or if no key exists.

Method Details

eval

public Object eval(Object l,
 Object key)
            throws EvaluationException

Description copied from class: BinaryFunction

Evaluate the function

Specified by:

eval in class BinaryFunction

Parameters:

l - lhs argument

key - rhs argument

Returns:

the results

Throws:

EvaluationException - if the function cannot be evaluated.

eval

protected Object eval(Map<Object,Object> map,
 Object key)

eval

protected Object eval(List<Object> list,
 Object key)
               throws EvaluationException

Throws:

EvaluationException

equals

protected boolean equals(Object key,
 Object k)
                  throws EvaluationException

Test if key equals k. Default implementation uses key.equals(k)

Parameters:

key - key to test

k - key to test

Returns:

true if parameters are equal

Throws:

EvaluationException