com.allanbank.mongodb.client.message

Class BatchedWriteCommand

java.lang.Object

com.allanbank.mongodb.client.message.AbstractMessage

com.allanbank.mongodb.client.message.Command

com.allanbank.mongodb.client.message.BatchedWriteCommand

All Implemented Interfaces:

Message

public class BatchedWriteCommand
extends Command

BatchedWriteCommand provides a container to hold the batched write command and the operations that it was created from.

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

2014, Allanbank Consulting, Inc., All Rights Reserved

Field Summary

Fields

Modifier and Type	Field and Description
static VersionRange	REQUIRED_VERSION_RANGE The required server version range for the BatchedWrite command.

Fields inherited from class com.allanbank.mongodb.client.message.Command

COMMAND_COLLECTION

Fields inherited from class com.allanbank.mongodb.client.message.AbstractMessage

HEADER_SIZE, myCollectionName, myDatabaseName

Constructor Summary

Constructors

Constructor and Description
BatchedWriteCommand(String databaseName, String collectionName, BatchedWrite.Bundle bundle) Create a new BatchedWriteCommand.
BatchedWriteCommand(String databaseName, String collectionName, Document commandDocument) Creates a new BatchedWriteCommand.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object object) Determines if the passed object is of this same type as this object and if so that its fields are equal.
BatchedWrite.Bundle	getBundle() Returns the bundle for the batched write.
int	hashCode() Computes a reasonable hash code.

Methods inherited from class com.allanbank.mongodb.client.message.Command

getCommand, getOperationName, getRoutingDocument, isAllowJumbo, setAllowJumbo, size, toString, validateSize, write, write

Methods inherited from class com.allanbank.mongodb.client.message.AbstractMessage

finishHeader, getCollectionName, getDatabaseName, getReadPreference, getRequiredVersionRange, init, writeHeader, writeHeader

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

REQUIRED_VERSION_RANGE

public static final VersionRange REQUIRED_VERSION_RANGE

The required server version range for the BatchedWrite command.

Constructor Detail

BatchedWriteCommand

public BatchedWriteCommand(String databaseName,
                   String collectionName,
                   BatchedWrite.Bundle bundle)

Create a new BatchedWriteCommand.

Parameters:

databaseName - The name of the database.

collectionName - The name of the collection the command is using. This should be the real collection and not $cmd if the real collection is known.

bundle - The bundle for the batched write.

BatchedWriteCommand

public BatchedWriteCommand(String databaseName,
                   String collectionName,
                   Document commandDocument)

Creates a new BatchedWriteCommand. This constructor is provided for tests that do not want to create a BatchedWrite.Bundle

Parameters:

databaseName - The name of the database.

collectionName - The name of the collection the command is using. This should be the real collection and not $cmd if the real collection is known.

commandDocument - The batch command document.

Method Detail

equals

public boolean equals(Object object)

Determines if the passed object is of this same type as this object and if so that its fields are equal.

Overrides:

equals in class Command

Parameters:

object - The object to compare to.

See Also:

Object.equals(java.lang.Object)

getBundle

public BatchedWrite.Bundle getBundle()

Returns the bundle for the batched write.

Returns:

The bundle for the batched write.

hashCode

public int hashCode()

Computes a reasonable hash code.

Overrides:

hashCode in class Command

Returns:

The hash code value.