com.allanbank.mongodb.builder.write

Enum WriteOperationType

java.lang.Object

java.lang.Enum<WriteOperationType>

com.allanbank.mongodb.builder.write.WriteOperationType

All Implemented Interfaces:

Serializable, Comparable<WriteOperationType>

public enum WriteOperationType
extends Enum<WriteOperationType>

WriteOperationType provides an enumeration of the types of writes.

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 ©:

2014, Allanbank Consulting, Inc., All Rights Reserved

Enum Constant Summary

Enum Constants

Enum Constant and Description
DELETE A delete operation.
INSERT An insert operation.
UPDATE An update operation.

Method Summary

Methods

Modifier and Type	Method and Description
static WriteOperationType	valueOf(String name) Returns the enum constant of this type with the specified name.
static WriteOperationType[]	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 WriteOperationType DELETE

A delete operation.

INSERT

public static final WriteOperationType INSERT

An insert operation.

UPDATE

public static final WriteOperationType UPDATE

An update operation.

Method Detail

values

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

Returns:

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

valueOf

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