public enum FormulaError extends java.lang.Enum<FormulaError>
Enum Constant and Description |
---|
_NO_ERROR |
CIRCULAR_REF
POI specific code to indicate that there is a circular reference
in the formula
|
DIV0
Intended to indicate when any number, including zero, is divided by zero.
|
FUNCTION_NOT_IMPLEMENTED
POI specific code to indicate that the funcition required is
not implemented in POI
|
NA
Intended to indicate when a designated value is not available.
|
NAME
Intended to indicate when what looks like a name is used, but no such name has been defined.
|
NULL
Intended to indicate when two areas are required to intersect, but do not.
|
NUM
Intended to indicate when an argument to a function has a compatible type, but has a
value that is outside the domain over which that function is defined.
|
REF
Intended to indicate when a cell reference is invalid.
|
VALUE
Intended to indicate when an incompatible type argument is passed to a function, or
an incompatible type operand is used with an operator.
|
Modifier and Type | Method and Description |
---|---|
static FormulaError |
forInt(byte type) |
static FormulaError |
forInt(int type) |
static FormulaError |
forString(java.lang.String code) |
byte |
getCode() |
int |
getLongCode() |
java.lang.String |
getString() |
static boolean |
isValidCode(int errorCode) |
static FormulaError |
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.
|
static FormulaError[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
@Internal public static final FormulaError _NO_ERROR
public static final FormulaError NULL
Example: In the case of SUM(B1 C1), the space between B1 and C1 is treated as the binary intersection operator, when a comma was intended. end example]
public static final FormulaError DIV0
public static final FormulaError VALUE
Example: In the case of a function argument, text was expected, but a number was provided
public static final FormulaError REF
Example: If a formula contains a reference to a cell, and then the row or column containing that cell is deleted, a #REF! error results. If a worksheet does not support 20,001 columns, OFFSET(A1,0,20000) will result in a #REF! error.
public static final FormulaError NAME
Example: XYZ/3, where XYZ is not a defined name. Total is & A10, where neither Total nor is is a defined name. Presumably, "Total is " & A10 was intended. SUM(A1C10), where the range A1:C10 was intended.
public static final FormulaError NUM
Example: Certain calls to ASIN, ATANH, FACT, and SQRT might result in domain errors.
Intended to indicate that the result of a function cannot be represented in a value of the specified type, typically due to extreme magnitude. (This is known as a range error.)Example: FACT(1000) might result in a range error.
public static final FormulaError NA
Example: Some functions, such as SUMX2MY2, perform a series of operations on corresponding elements in two arrays. If those arrays do not have the same number of elements, then for some elements in the longer array, there are no corresponding elements in the shorter one; that is, one or more values in the shorter array are not available.
This error value can be produced by calling the function NApublic static final FormulaError CIRCULAR_REF
public static final FormulaError FUNCTION_NOT_IMPLEMENTED
public static FormulaError[] values()
for (FormulaError c : FormulaError.values()) System.out.println(c);
public static FormulaError valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is nullpublic byte getCode()
public int getLongCode()
public java.lang.String getString()
public static boolean isValidCode(int errorCode)
public static FormulaError forInt(byte type) throws java.lang.IllegalArgumentException
java.lang.IllegalArgumentException
public static FormulaError forInt(int type) throws java.lang.IllegalArgumentException
java.lang.IllegalArgumentException
public static FormulaError forString(java.lang.String code) throws java.lang.IllegalArgumentException
java.lang.IllegalArgumentException
Copyright 2021 The Apache Software Foundation or its licensors, as applicable.