Package com.grapecity.documents.excel.expressions

Enum Class OperatorKind

java.lang.Object

java.lang.Enum<OperatorKind>

com.grapecity.documents.excel.expressions.OperatorKind

All Implemented Interfaces:

Serializable, Comparable<OperatorKind>, Constable

public enum OperatorKind
extends Enum<OperatorKind>

Represents formula operators.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Addition	Represents the + operator.
Concatenate	Represents the & operator.
Division	Represents the / operator.
Equality	Represents the = operator.
Exponent	Represents the ^ operator.
GreaterThan	Represents the > operator.
GreaterThanOrEqual	Represents the >= operator.
Inequality	Represents the <> operator.
Intersection	Represents the (space) operator.
LessThan	Represents the < operator.
LessThanOrEqual	Represents the <= operator.
Multiply	Represents the * operator.
Percentage	Represents the % operator.
Range	Represents the : operator.
Single	Represents the ＠ operator. Aggregates a range of cells spilled by Dynamic Array functions into a single cell.
Spill	Represents the # operator.
Subtraction	Represents the - operator.
Union	Represents the , operator.

Method Summary

Modifier and Type	Method	Description
static OperatorKind	forValue(int value)
int	getValue()
static OperatorKind	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OperatorKind[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

Addition

public static final OperatorKind Addition

Represents the + operator.

The + operator has the primary purpose of adding two numbers.
This operator is defined only for double operands, and it alwaysnarrows its operands to double.
Syntax:
expression1 + expression2 or +expression2
Parts:
expression1: Optional. Any numeric or string expression.
expression2: Required. Any numeric or string expression.

Subtraction

public static final OperatorKind Subtraction

Represents the - operator.

Returns the difference between two numeric expressions or the negative value of a numeric expression.
Syntax:
expression1 - expression2 or -expression2
Parts:
expression1: Optional. Any numeric or string expression.
expression2: Required. Any numeric or string expression.

Multiply

public static final OperatorKind Multiply

Represents the * operator.

Multiplies two numbers.
Syntax:
expression1 * expression2
Parts:
expression1: Required. Any numeric or string expression.
expression2: Required. Any numeric or string expression.

Division

public static final OperatorKind Division

Represents the / operator.

Divides two numbers and returns a floating-point result, including any remainder.
The QUOTIENT function returns the integer quotient, which drops theremainder.
Syntax:
expression1 / expression2
Parts:
expression1: Required. Any numeric or string expression.
expression2: Required. Any numeric or string expression.

Exponent

public static final OperatorKind Exponent

Represents the ^ operator.

Raises a number to the power of another number, always as a doublevalue.
Syntax:
number ^ exponent
Parts:
number: Required. Any numeric or string expression.
exponent: Required. Any numeric or string expression.

Percentage

public static final OperatorKind Percentage

Represents the % operator.

Divides a number by 100.
Syntax:
expression1%
Parts:
expression1: Required. Any numeric or string expression.

Concatenate

public static final OperatorKind Concatenate

Represents the & operator.

Concatenation operators join multiple strings into a single string. The & operator is defined only for string operands, and it always widensits operands to string.
Syntax:
expression1 & expression2
Parts:
expression1: Required. Any expression with a data type that widens to String.
expression2: Required. Any expression with a data type that widens to String.

Range

public static final OperatorKind Range

Represents the : operator.

The range operator gives a range of cells within start point and end point reference cells.
Syntax:
range1:range2
Parts:
range1: Required. Must be a range expression.
range2: Required. Must be a range expression.

Union

public static final OperatorKind Union

Represents the , operator.

The union operator combines two or more than two references into a single reference.
Syntax:
range1,range2
Parts:
range1: Required. Must be a range expression.
range2: Required. Must be a range expression.

Intersection

public static final OperatorKind Intersection

Represents the (space) operator.

The intersection operator gives reference to those cells which are common in two range arguments.
Syntax:
range1 range2
Parts:
range1: Required. Must be a range expression.
range2: Required. Must be a range expression.

Spill

public static final OperatorKind Spill

Represents the # operator.

Refers to a range of cells spilled from the specific cell.
Syntax:
expression#
Parts:
expression: Required. Any cell reference expression.

Single

public static final OperatorKind Single

Represents the ＠ operator.
Aggregates a range of cells spilled by Dynamic Array functions into a single cell.
Syntax:
@expression
Parts:
expression: Required. Any range or function call expression.

Equality

public static final OperatorKind Equality

Represents the = operator.

The equality operator compares two expressions to determine whether or not they are equal.
Syntax:
expression1 = expression2
Parts:
expression1: Required. Any expression.
expression2: Required. Any expression.

Inequality

public static final OperatorKind Inequality

Represents the <> operator.

The inequality operator compares two expressions to determine whether they are not equal.
Syntax:
expression1 <> expression2
Parts:
expression1: Required. Any expression.
expression2: Required. Any expression.

LessThan

public static final OperatorKind LessThan

Represents the < operator.

The less than operator compares two expressions to determine whether the left side is less than the right side.
Syntax:
expression1 < expression2
Parts:
expression1: Required. Any expression.
expression2: Required. Any expression.

LessThanOrEqual

public static final OperatorKind LessThanOrEqual

Represents the <= operator.

The less than or equal operator compares two expressions to determine whether the left side is less than or equal to the right side.
Syntax:
expression1 <= expression2
Parts:
expression1: Required. Any expression.
expression2: Required. Any expression.

GreaterThan

public static final OperatorKind GreaterThan

Represents the > operator.

The greater than operator compares two expressions to determine whether the left side is greater than the right side.
Syntax:
expression1 > expression2
Parts:
expression1: Required. Any expression.
expression2: Required. Any expression.

GreaterThanOrEqual

public static final OperatorKind GreaterThanOrEqual

Represents the >= operator.

The greater than operator compares two expressions to determine whether the left side is greater than or equal to the right side.
Syntax:
expression1 >= expression2
Parts:
expression1: Required. Any expression.
expression2: Required. Any expression.

Method Details

values

public static OperatorKind[] 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

public static OperatorKind valueOf(String name)

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 name

NullPointerException - if the argument is null

getValue

public int getValue()

forValue

public static OperatorKind forValue(int value)