com.allanbank.mongodb.builder

Enum BatchedWriteMode

java.lang.Object

java.lang.Enum<BatchedWriteMode>

com.allanbank.mongodb.builder.BatchedWriteMode

All Implemented Interfaces:

Serializable, Comparable<BatchedWriteMode>

public enum BatchedWriteMode
extends Enum<BatchedWriteMode>

BatchedWriteMode provides enumeration of the available modes for submitting the batched 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
REORDERED Indicates that the writes can be reordered to optimize the write performance.
SERIALIZE_AND_CONTINUE Indicates that the writes should be submitted to the server in the order they were added to the BatchedWrite but that all writes should be tried on the server even after a failure.
SERIALIZE_AND_STOP Indicates that the writes should be submitted to the server in the order they were added to the BatchedWrite and that the writes should stop on the first write failure.

Method Summary

Methods

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

REORDERED

public static final BatchedWriteMode REORDERED

Indicates that the writes can be reordered to optimize the write performance. This included re-ordering writes within a WriteOperationType (e.g., move one insert before another to better pack messages to the server) and across types (e.g., move an insert before an update to group all like operations).

This mode should provide close to optimal performance.

SERIALIZE_AND_CONTINUE

public static final BatchedWriteMode SERIALIZE_AND_CONTINUE

Indicates that the writes should be submitted to the server in the order they were added to the BatchedWrite but that all writes should be tried on the server even after a failure.

This mode will perform better than the SERIALIZE_AND_STOP mode since the driver can submit multiple writes to the server at once.

SERIALIZE_AND_STOP

public static final BatchedWriteMode SERIALIZE_AND_STOP

Indicates that the writes should be submitted to the server in the order they were added to the BatchedWrite and that the writes should stop on the first write failure.

This mode will perform slower than all of the other modes since the driver must wait for the results of one write before submitting the next.

Method Detail

values

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

Returns:

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

valueOf

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