Package com.singularsys.jep.misc.functions

# Class SwitchDefaultNonLazy

java.lang.Object
com.singularsys.jep.functions.PostfixMathCommand
com.singularsys.jep.functions.NaryFunction
com.singularsys.jep.misc.functions.SwitchDefaultNonLazy

All Implemented Interfaces:
  `PostfixMathCommandI`, `Serializable`

public class SwitchDefaultNonLazy extends NaryFunction
A switch statement, with a default value. The argument is selected based on the integer value of the first argument, the last argument is returned if the first argument is greater than the number of arguments -2. For example `switchDefault(2,5,6,7,8)` will return 5, and `switchDefault(9,5,6,7,8)` will return 8. The first argument must be an exact integer.

This is the non-lazy version of the function, all arguments are evaluated before the switch statement is executed. See `SwitchDefault` for the lazy evaluation version.

Since:
  Jep 4.1
Author:
  Richard Morris
See Also:
  - `Case`
  - Serialized Form

- ## Nested Class Summary

  Nested Classes
  Modifier and Type
  Class
  Description
  `static enum`
  `SwitchDefaultNonLazy.NullBehaviour`
  Action to take if first argument is null.

- ## Field Summary

  Fields
  Modifier and Type
  Field
  Description
  `protected SwitchDefaultNonLazy.NullBehaviour`
  `nullBehaviour`

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

  `curNumberOfParameters, description, name, NaN, numberOfParameters`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `SwitchDefaultNonLazy()`
  Default switch statement.
  `SwitchDefaultNonLazy(SwitchDefaultNonLazy.NullBehaviour nullBehaviour)`
  Switch function with defined null behaviour.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `boolean`
  `checkNumberOfParameters(int n)`
  Checks the number of parameters of the function.
  `Object`
  `eval(Object[] args)`
  Evaluate the function
  `SwitchDefaultNonLazy.NullBehaviour`
  `getNullBehaviour()`
  Behaviour when passed zero arguments.

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

  `run`

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

  `asArray, asBool, asDouble, asInt, asLong, asStrictInt, asString, asType, 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

  - ### nullBehaviour

    protected SwitchDefaultNonLazy.NullBehaviour nullBehaviour

- ## Constructor Details

  - ### SwitchDefaultNonLazy

    public SwitchDefaultNonLazy()
    Default switch statement. Exceptions are thrown if first argument is null.

  - ### SwitchDefaultNonLazy

    public SwitchDefaultNonLazy(SwitchDefaultNonLazy.NullBehaviour nullBehaviour)
    Switch function with defined null behaviour.
    Parameters:
      `nullBehaviour` - action to take if first argument is null.
    Since:
      Jep 3.5

- ## Method Details

  - ### checkNumberOfParameters

    public boolean checkNumberOfParameters(int n)
    Description copied from class: `PostfixMathCommand`
    Checks the number of parameters of the function. Functions which set numberOfParameter=-1 should overload this method
    Specified by:
      `checkNumberOfParameters` in interface `PostfixMathCommandI`
    Overrides:
      `checkNumberOfParameters` in class `PostfixMathCommand`
    Parameters:
      `n` - number of parameters function will be called with.
    Returns:
      false if an illegal number of parameters is supplied, true otherwise.

  - ### getNullBehaviour

    public SwitchDefaultNonLazy.NullBehaviour getNullBehaviour()
    Behaviour when passed zero arguments.
    Returns:
      code indicating behaviour type
    Since:
      Jep 3.5

  - ### eval

    public Object eval(Object[] args) throws EvaluationException
    Description copied from class: `NaryFunction`
    Evaluate the function
    Specified by:
      `eval` in class `NaryFunction`
    Parameters:
      `args` - arguments to the function
    Returns:
      value returned by the function
    Throws:
      `EvaluationException` - if the calculation cannot be performed