Enum Class FormulaError
- All Implemented Interfaces:
Serializable
,Comparable<FormulaError>
,Constable
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionPOI specific code to indicate that there is a circular reference in the formulaIntended to indicate when any number, including zero, is divided by zero.POI specific code to indicate that the funcition required is not implemented in POIIntended to indicate when a designated value is not available.Intended to indicate when what looks like a name is used, but no such name has been defined.Intended to indicate when two areas are required to intersect, but do not.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.Intended to indicate when a cell reference is invalid.Intended to indicate when an incompatible type argument is passed to a function, or an incompatible type operand is used with an operator. -
Method Summary
Modifier and TypeMethodDescriptionstatic FormulaError
forInt
(byte type) static FormulaError
forInt
(int type) static FormulaError
byte
getCode()
int
static boolean
isValidCode
(int errorCode) static FormulaError
Returns the enum constant of this class with the specified name.static FormulaError[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
_NO_ERROR
-
NULL
Intended to indicate when two areas are required to intersect, but do not.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]
-
DIV0
Intended to indicate when any number, including zero, is divided by zero. Note: However, any error code divided by zero results in that error code. -
VALUE
Intended to indicate when an incompatible type argument is passed to a function, or an incompatible type operand is used with an operator.Example: In the case of a function argument, text was expected, but a number was provided
-
REF
Intended to indicate when a cell reference is invalid.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.
-
NAME
Intended to indicate when what looks like a name is used, but no such name has been defined.Example: XYZ/3, where XYZ is not a defined name. Total is invalid input: '&' A10, where neither Total nor is is a defined name. Presumably, "Total is " invalid input: '&' A10 was intended. SUM(A1C10), where the range A1:C10 was intended.
-
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. (This is known as a domain error.)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.
-
NA
Intended to indicate when a designated value is not available.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 NA -
CIRCULAR_REF
POI specific code to indicate that there is a circular reference in the formula -
FUNCTION_NOT_IMPLEMENTED
POI specific code to indicate that the funcition required is not implemented in POI
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-
getCode
public byte getCode()- Returns:
- numeric code of the error
-
getLongCode
public int getLongCode()- Returns:
- long (internal) numeric code of the error
-
getString
- Returns:
- string representation of the error
-
isValidCode
public static boolean isValidCode(int errorCode) -
forInt
- Throws:
IllegalArgumentException
-
forInt
- Throws:
IllegalArgumentException
-
forString
- Throws:
IllegalArgumentException
-