Package io.keikai.range.formula

Class EvaluationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

io.keikai.range.formula.EvaluationException

All Implemented Interfaces:

Serializable

public final class EvaluationException
extends Exception

Checked exception thrown by helper-base function implementations (such as TextFunction, MultiOperandNumericFunction) to signal an Excel error result without short-circuiting the entire evaluator.

The wrapped ErrorEval is what the calling base class returns to the formula engine. Custom code should generally use the named factories (invalidValue(), numberError(), …) instead of constructing the wrapped ErrorEval directly.

Replaces org.apache.poi.ss.formula.eval.EvaluationException.

Since:

7.0.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
EvaluationException(ErrorEval errorEval)

Method Summary

Modifier and Type	Method	Description
static EvaluationException	divideByZero()
ErrorEval	getErrorEval()
static EvaluationException	invalidRef()
static EvaluationException	invalidValue()
static EvaluationException	numberError()

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Details

EvaluationException

public EvaluationException(ErrorEval errorEval)

Method Details

getErrorEval

public ErrorEval getErrorEval()

Returns:

the ErrorEval that should be returned in lieu of a normal result.

invalidValue

public static EvaluationException invalidValue()

invalidRef

public static EvaluationException invalidRef()

numberError

public static EvaluationException numberError()

divideByZero

public static EvaluationException divideByZero()