com.allanbank.mongodb.builder

Enum ComparisonOperator

java.lang.Object

java.lang.Enum<ComparisonOperator>

com.allanbank.mongodb.builder.ComparisonOperator

All Implemented Interfaces:

Operator, Serializable, Comparable<ComparisonOperator>

public enum ComparisonOperator
extends Enum<ComparisonOperator>
implements Operator

ComparisonOperator provides an enumeration of all possible comparison operators.

API Notice:

This enumeration is part of the driver's API. Public and protected members will be deprecated for at least 1 non-bugfix release (version numbers are <major>.<minor>.<bugfix>) before being removed or modified.

Copyright ©:

2012-2013, Allanbank Consulting, Inc., All Rights Reserved

Enum Constant Summary

Enum Constants

Enum Constant and Description
EQUALS The equal operator.
GT The greater than operator.
GTE The greater than or equal operator.
LT The less than operator.
LTE The less than or equal operator.
NE The not equal operator.

Method Summary

Methods

Modifier and Type	Method and Description
String	getToken() The token for the operator that can be sent to the server.
static ComparisonOperator	valueOf(String name) Returns the enum constant of this type with the specified name.
static ComparisonOperator[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EQUALS

public static final ComparisonOperator EQUALS

The equal operator. Note that this operator does not have a token.

GT

public static final ComparisonOperator GT

The greater than operator.

GTE

public static final ComparisonOperator GTE

The greater than or equal operator.

LT

public static final ComparisonOperator LT

The less than operator.

LTE

public static final ComparisonOperator LTE

The less than or equal operator.

NE

public static final ComparisonOperator NE

The not equal operator.

Method Detail

values

public static ComparisonOperator[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ComparisonOperator c : ComparisonOperator.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ComparisonOperator valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getToken

public String getToken()

The token for the operator that can be sent to the server.

Specified by:

getToken in interface Operator

Returns:

The token for the operator.