com.allanbank.mongodb.client

Enum Operation

java.lang.Object

java.lang.Enum<Operation>

com.allanbank.mongodb.client.Operation

All Implemented Interfaces:

Serializable, Comparable<Operation>

public enum Operation
extends Enum<Operation>

Enumeration of the possible operations allowed in MongoDB messages.

API Warning:

This class is NOT part of the drivers API. This class may be mutated in incompatible ways between any two releases of the driver.

Copyright ©:

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
DELETE Delete documents.
GET_MORE Get more data from a query.
INSERT Insert new document.
KILL_CURSORS Tell database client is done with a cursor.
QUERY Query a collection.
REPLY Reply to a client request.
UPDATE Update a document.

Method Summary

Methods

Modifier and Type	Method and Description
static Operation	fromCode(int opCode) Returns the Operation for the provided opCode.
int	getCode() Returns the Operation's code.
static Operation	valueOf(String name) Returns the enum constant of this type with the specified name.
static Operation[]	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

DELETE

public static final Operation DELETE

Delete documents.

GET_MORE

public static final Operation GET_MORE

Get more data from a query.

INSERT

public static final Operation INSERT

Insert new document.

KILL_CURSORS

public static final Operation KILL_CURSORS

Tell database client is done with a cursor.

QUERY

public static final Operation QUERY

Query a collection.

REPLY

public static final Operation REPLY

Reply to a client request.

UPDATE

public static final Operation UPDATE

Update a document.

Method Detail

values

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

Returns:

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

valueOf

public static Operation 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

fromCode

public static Operation fromCode(int opCode)

Returns the Operation for the provided opCode.

Parameters:

opCode - The operation code for the Operation.

Returns:

The Operation for the operation code or null if the operation code is invalid.

getCode

public int getCode()

Returns the Operation's code.

Returns:

The operation's code.