ModFunction (Nebula NatTable 2.0.5-SNAPSHOT API)

java.lang.Object
- org.eclipse.nebula.widgets.nattable.formula.function.AbstractFunction
- - org.eclipse.nebula.widgets.nattable.formula.function.AbstractMathFunction
  - - org.eclipse.nebula.widgets.nattable.formula.function.ModFunction

All Implemented Interfaces:

FunctionValue, OperatorFunctionValue
```
public class ModFunction
extends AbstractMathFunction
```
Returns the remainder from a division between two supplied numbers.

Since:

1.4

- Field Summary
  - Fields inherited from class org.eclipse.nebula.widgets.nattable.formula.function.AbstractFunction
    values
- Constructor Summary
  
  Constructors
  Constructor Description
  
  ModFunction()
  
  ModFunction(List<FunctionValue> values)
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  BigDecimal getValue()
  
  String toString()
  - Methods inherited from class org.eclipse.nebula.widgets.nattable.formula.function.AbstractMathFunction
    addFunctionValue, convertValue, validateMethodParameter
  - Methods inherited from class org.eclipse.nebula.widgets.nattable.formula.function.AbstractFunction
    isEmpty
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ModFunction
```
public ModFunction()
```
  - ModFunction
```
public ModFunction(List<FunctionValue> values)
```
- Method Detail
  - getValue
```
public BigDecimal getValue()
```
    Returns:
    
    The value this FunctionValue carries or calculates based on its function.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object