com.allanbank.mongodb.builder

Enum LogicalOperator

java.lang.Object

java.lang.Enum<LogicalOperator>

com.allanbank.mongodb.builder.LogicalOperator

All Implemented Interfaces:

Operator, Serializable, Comparable<LogicalOperator>

public enum LogicalOperator
extends Enum<LogicalOperator>
implements Operator

LogicalOperator provides the set of logical 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
AND The logical conjunction operator.
NOR The logical negated disjunction operator.
NOT The logical negation operator.
OR The logical disjunction operator.

Method Summary

Methods

Modifier and Type	Method and Description
String	getToken() The token for the operator that can be sent to the server.
Version	getVersion() Returns the first MongoDB version to support the operator.
static LogicalOperator	valueOf(String name) Returns the enum constant of this type with the specified name.
static LogicalOperator[]	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

AND

public static final LogicalOperator AND

The logical conjunction operator.

NOR

public static final LogicalOperator NOR

The logical negated disjunction operator.

NOT

public static final LogicalOperator NOT

The logical negation operator.

OR

public static final LogicalOperator OR

The logical disjunction operator.

Method Detail

values

public static LogicalOperator[] 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 (LogicalOperator c : LogicalOperator.values())
    System.out.println(c);

Returns:

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

valueOf

public static LogicalOperator 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.

getVersion

public Version getVersion()

Returns the first MongoDB version to support the operator.

Specified by:

getVersion in interface Operator

Returns:

The first MongoDB version to support the operator. If null then the version is not known and can be assumed to be all currently supported versions.