Package com.singularsys.jep.misc.nullwrapper.functions

# Class NullSafeEquals

java.lang.Object
com.singularsys.jep.functions.PostfixMathCommand
com.singularsys.jep.functions.BinaryFunction
com.singularsys.jep.functions.Comparative
com.singularsys.jep.misc.nullwrapper.functions.NullSafeEquals

All Implemented Interfaces:
  `NullWrappedFunctionI`, `PostfixMathCommandI`, `Serializable`

public class NullSafeEquals extends Comparative implements NullWrappedFunctionI
The Null Safe equals function. null <=> null is true; null <=> non-null is false; not-null <=> null is false; other value as Comparative

Since:
  3.4
Author:
  Richard Morris
See Also:
  - Serialized Form

- ## Nested Class Summary

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

  `BinaryFunction.BiFunctionWithException<T>`

- ## Field Summary

  ### Fields inherited from class com.singularsys.jep.functions.Comparative

  `EQ, GE, GT, LE, LT, NE`

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

  `curNumberOfParameters, description, name, NaN, numberOfParameters`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `NullSafeEquals()`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `Object`
  `eval(Object l, Object r)`
  Evaluate the function
  `PostfixMathCommandI`
  `getRoot()`
  Get to function which this function wraps.

  ### Methods inherited from class com.singularsys.jep.functions.Comparative

  `compare, eq, ge, getDescription, getId, getTolerance, gt, le, lt, ne, setTolerance`

  ### 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, 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`

- ## Constructor Details

  - ### NullSafeEquals

    public NullSafeEquals()

- ## Method Details

  - ### getRoot

    public PostfixMathCommandI getRoot()
    Description copied from interface: `NullWrappedFunctionI`
    Get to function which this function wraps.
    Specified by:
      `getRoot` in interface `NullWrappedFunctionI`
    Returns:
      the root function, may be "this".

  - ### eval

    public Object eval(Object l, Object r) throws EvaluationException
    Description copied from class: `BinaryFunction`
    Evaluate the function
    Overrides:
      `eval` in class `Comparative`
    Parameters:
      `l` - lhs argument
      `r` - rhs argument
    Returns:
      the results
    Throws:
      `EvaluationException` - if the function cannot be evaluated.