Top Description Fields Constructors Methods
org.apache.poi.ss.format

public abstract Class CellFormatCondition

extends Object
Class Inheritance
Imports
java.util.HashMap, .Map

This object represents a condition in a cell format.

Field Summary

Modifier and TypeField and Description
private static final int
private static final int
private static final int
private static final int
private static final int
private static final int
private static final Map<String, Integer>

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public static CellFormatCondition

Returns:

A condition object for the given condition.
getInstance
(String
The operator as a string. One of <, <=, >, >=, =, ==, != or <>.
opString
,
String
The constant (such as 12).
constStr
)

Returns an instance of a condition object.

public abstract boolean

Returns:

true if the given value passes the constraint's test.
pass
(double
The value to compare against.
value
)

Returns true if the given value passes the constraint's test.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

EQback to summary
private static final int EQ
GEback to summary
private static final int GE
GTback to summary
private static final int GT
LEback to summary
private static final int LE
LTback to summary
private static final int LT
NEback to summary
private static final int NE
TESTSback to summary
private static final Map<String, Integer> TESTS

Constructor Detail

CellFormatConditionback to summary
public CellFormatCondition()

Method Detail

getInstanceback to summary
public static CellFormatCondition getInstance(String opString, String constStr)

Returns an instance of a condition object.

Parameters
opString:String

The operator as a string. One of <, <=, >, >=, =, ==, != or <>.

constStr:String

The constant (such as 12).

Returns:CellFormatCondition

A condition object for the given condition.

passback to summary
public abstract boolean pass(double value)

Returns true if the given value passes the constraint's test.

Parameters
value:double

The value to compare against.

Returns:boolean

true if the given value passes the constraint's test.