Package com.yahoo.document.update

Enum Class ArithmeticValueUpdate.Operator

java.lang.Object

java.lang.Enum<ArithmeticValueUpdate.Operator>

com.yahoo.document.update.ArithmeticValueUpdate.Operator

All Implemented Interfaces:

Serializable, Comparable<ArithmeticValueUpdate.Operator>, Constable

Enclosing class:

ArithmeticValueUpdate

public static enum ArithmeticValueUpdate.Operator
extends Enum<ArithmeticValueUpdate.Operator>

Lists valid operations that can be performed by an ArithmeticValueUpdate.

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
ADD	Add the operand to the value.
DIV	Divide the value by the operand.
MUL	Multiply the value by the operand.
SUB	Subtract the operand from the value.

Field Summary

Fields

Modifier and Type	Field	Description
final int	id	The numeric ID of the operator, used for serialization.
final String	name	The name of the operator, mainly used in toString() methods.

Method Summary

Modifier and Type	Method	Description
static ArithmeticValueUpdate.Operator	getID(int id)	Returns the operator with the specified ID.
static ArithmeticValueUpdate.Operator	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ArithmeticValueUpdate.Operator[]	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

ADD

public static final ArithmeticValueUpdate.Operator ADD

Add the operand to the value.

DIV

public static final ArithmeticValueUpdate.Operator DIV

Divide the value by the operand.

MUL

public static final ArithmeticValueUpdate.Operator MUL

Multiply the value by the operand.

SUB

public static final ArithmeticValueUpdate.Operator SUB

Subtract the operand from the value.

Field Details

id

public final int id

The numeric ID of the operator, used for serialization.

name

public final String name

The name of the operator, mainly used in toString() methods.

Method Details

values

public static ArithmeticValueUpdate.Operator[] 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 ArithmeticValueUpdate.Operator 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

getID

public static ArithmeticValueUpdate.Operator getID(int id)

Returns the operator with the specified ID.

Parameters:

id - the ID to search for

Returns:

the Operator with the specified ID, or null if it does not exist.