com.mongodb.connection

Class DeleteCommandMessage

java.lang.Object

com.mongodb.connection.RequestMessage

com.mongodb.connection.BaseWriteCommandMessage

com.mongodb.connection.DeleteCommandMessage

class DeleteCommandMessage
extends BaseWriteCommandMessage

A message for the delete command.

Nested Class Summary

Nested classes/interfaces inherited from class com.mongodb.connection.RequestMessage

RequestMessage.EncodingMetadata, RequestMessage.OpCode

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<DeleteRequest>	deletes

Fields inherited from class com.mongodb.connection.RequestMessage

REQUEST_ID

Constructor Summary

Constructors

Constructor and Description
DeleteCommandMessage(MongoNamespace namespace, boolean ordered, WriteConcern writeConcern, MessageSettings settings, java.util.List<DeleteRequest> deletes) Construct an instance.

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getCommandName() Gets the name of the write command
protected FieldNameValidator	getFieldNameValidator() Gets the field name validator to apply.
int	getItemCount() Gets the number of write requests left to encode.
java.util.List<DeleteRequest>	getRequests() Gets the list of requests.
protected BaseWriteCommandMessage	writeTheWrites(BsonOutput bsonOutput, int commandStartPosition, BsonBinaryWriter writer) Write the list of writes to the output after the write command prologue has been written.

Methods inherited from class com.mongodb.connection.BaseWriteCommandMessage

encode, encodeMessageBody, encodeMessageBodyWithMetadata, exceedsLimits, getBypassDocumentValidation, getWriteConcern, getWriteNamespace, isOrdered

Methods inherited from class com.mongodb.connection.RequestMessage

addCollectibleDocument, addDocument, backpatchMessageLength, encodeWithMetadata, getCodec, getCollectionName, getCurrentGlobalId, getId, getNamespace, getOpCode, getSettings, writeMessagePrologue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

deletes

private final java.util.List<DeleteRequest> deletes

Constructor Detail

DeleteCommandMessage

public DeleteCommandMessage(MongoNamespace namespace,
                            boolean ordered,
                            WriteConcern writeConcern,
                            MessageSettings settings,
                            java.util.List<DeleteRequest> deletes)

Construct an instance.

Parameters:

namespace - the namespace

ordered - whether the writes are ordered

writeConcern - the write concern

settings - the message settings

deletes - the list of delete requests

Method Detail

getItemCount

public int getItemCount()

Description copied from class: BaseWriteCommandMessage

Gets the number of write requests left to encode. Note that these may end up being split into multiple messages.

Specified by:

getItemCount in class BaseWriteCommandMessage

Returns:

the count of write requests left to encode

getFieldNameValidator

protected FieldNameValidator getFieldNameValidator()

Description copied from class: BaseWriteCommandMessage

Gets the field name validator to apply.

Specified by:

getFieldNameValidator in class BaseWriteCommandMessage

Returns:

the validator

getRequests

public java.util.List<DeleteRequest> getRequests()

Gets the list of requests.

Returns:

the list of requests

getCommandName

protected java.lang.String getCommandName()

Description copied from class: BaseWriteCommandMessage

Gets the name of the write command

Specified by:

getCommandName in class BaseWriteCommandMessage

Returns:

the name of the write command

writeTheWrites

protected BaseWriteCommandMessage writeTheWrites(BsonOutput bsonOutput,
                                                 int commandStartPosition,
                                                 BsonBinaryWriter writer)

Description copied from class: BaseWriteCommandMessage

Write the list of writes to the output after the write command prologue has been written.

Specified by:

writeTheWrites in class BaseWriteCommandMessage

Parameters:

bsonOutput - the BSON output

commandStartPosition - the position in the output where the command document starts

writer - the writer

Returns:

the next message to encode, if this one overflowed. This may be null, which indicates that we're done