Apache POI - Common 5.3.0 · org.apache.poi.ss.usermodel.FormulaError

Field Summary

Modifier and Type	Field and Description
public static final FormulaError	_NO_ERROR
private static final Map<Byte, FormulaError>	bmap
public static final FormulaError	CIRCULAR_REF POI specific code to indicate that there is a circular reference in the formula
public static final FormulaError	DIV0 Intended to indicate when any number, including zero, is divided by zero.
public static final FormulaError	FUNCTION_NOT_IMPLEMENTED POI specific code to indicate that the function required is not implemented in POI
private static final Map<Integer, FormulaError>	imap
private final int	longType
public static final FormulaError	NA Intended to indicate when a designated value is not available.
public static final FormulaError	NAME Intended to indicate when what looks like a name is used, but no such name has been defined.
public static final FormulaError	NULL Intended to indicate when two areas are required to intersect, but do not.
public static final FormulaError	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.
public static final FormulaError	REF Intended to indicate when a cell reference is invalid.
private final String	repr
private static final Map<String, FormulaError>	smap
private final byte	type
public static final FormulaError	VALUE Intended to indicate when an incompatible type argument is passed to a function, or an incompatible type operand is used with an operator.

Constructor Summary

Access	Constructor and Description
private	FormulaError(int type, String repr)

Method Summary

Modifier and Type	Method and Description
public static FormulaError	forInt(byte type)
public static FormulaError	forInt(int type)
public static FormulaError	forString(String code)
public byte	Returns: numeric code of the error getCode()
public int	Returns: long (internal) numeric code of the error getLongCode()
public String	Returns: string representation of the error getString()
public static boolean	isValidCode(int errorCode)
public static FormulaError	valueOf(String name)
public static FormulaError[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

_NO_ERROR	back to summary
public static final FormulaError _NO_ERROR Annotations @Internal

bmap	back to summary
private static final Map<Byte, FormulaError> bmap

CIRCULAR_REF	back to summary
public static final FormulaError CIRCULAR_REF POI specific code to indicate that there is a circular reference in the formula

DIV0	back to summary
public static final FormulaError 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.

FUNCTION_NOT_IMPLEMENTED	back to summary
public static final FormulaError FUNCTION_NOT_IMPLEMENTED POI specific code to indicate that the function required is not implemented in POI

imap	back to summary
private static final Map<Integer, FormulaError> imap

longType	back to summary
private final int longType

NA	back to summary
public static final FormulaError 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

back to summary

public static final FormulaError 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

NAME back to summary

NAME	back to summary
public static final FormulaError 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 & 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 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 & 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.

NULL	back to summary
public static final FormulaError 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]

NULL

back to summary

public static final FormulaError 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]

NUM	back to summary
public static final FormulaError 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.

NUM

back to summary

public static final FormulaError 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.

REF	back to summary
public static final FormulaError 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.

REF

back to summary

public static final FormulaError 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.

repr	back to summary
private final String repr

smap	back to summary
private static final Map<String, FormulaError> smap

type	back to summary
private final byte type

VALUE	back to summary
public static final FormulaError 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

VALUE

back to summary

public static final FormulaError 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

Constructor Detail

FormulaError	back to summary
private FormulaError(int type, String repr)

Method Detail

forInt	back to summary
public static FormulaError forInt(byte type) throws IllegalArgumentException

forInt	back to summary
public static FormulaError forInt(int type) throws IllegalArgumentException

forString	back to summary
public static FormulaError forString(String code) throws IllegalArgumentException

getCode	back to summary
public byte getCode() Returns:byte numeric code of the error

getLongCode	back to summary
public int getLongCode() Returns:int long (internal) numeric code of the error

getString	back to summary
public String getString() Returns:String string representation of the error

isValidCode	back to summary
public static boolean isValidCode(int errorCode)

valueOf	back to summary
public static FormulaError valueOf(String name)

values	back to summary
public static FormulaError[] values()

public final Enum FormulaError

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail