com.allanbank.mongodb.builder.write

Class DeleteOperation

java.lang.Object

com.allanbank.mongodb.builder.write.DeleteOperation

All Implemented Interfaces:

WriteOperation, Serializable

public class DeleteOperation
extends Object
implements WriteOperation

DeleteOperation provides a container for the fields in a delete request.

See Also:

Serialized Form

API Notice:

This class 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

Constructor Summary

Constructors

Constructor and Description
DeleteOperation(DocumentAssignable query, boolean singleDelete) Creates a new DeleteOperation.

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.
Document	getQuery() Returns the query to find the documents to delete.
Document	getRoutingDocument() Returns the document that should be used to route the write operation.
WriteOperationType	getType() Returns the type of write.
int	hashCode() Computes a reasonable hash code.
boolean	isSingleDelete() Returns true if the operation should only delete at most one document.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteOperation

public DeleteOperation(DocumentAssignable query,
               boolean singleDelete)

Creates a new DeleteOperation.

Parameters:

query - The query to find the documents to delete.

singleDelete - If true then only a single document will be deleted. If running in a sharded environment then this field must be false or the query must contain the shard key.

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 Object

Parameters:

object - The object to compare to.

See Also:

Object.equals(Object)

getQuery

public Document getQuery()

Returns the query to find the documents to delete.

Returns:

The query to find the documents to delete.

getRoutingDocument

public Document getRoutingDocument()

Returns the document that should be used to route the write operation.

Overridden to return the query for the delete.

Specified by:

getRoutingDocument in interface WriteOperation

Returns:

The document that should be used to route the write operation.

getType

public final WriteOperationType getType()

Returns the type of write. Can be used to avoid instance of calls and in switch statements.

Overridden to return WriteOperationType.DELETE.

Specified by:

getType in interface WriteOperation

Returns:

The type of write.

hashCode

public int hashCode()

Computes a reasonable hash code.

Overrides:

hashCode in class Object

Returns:

The hash code value.

isSingleDelete

public boolean isSingleDelete()

Returns true if the operation should only delete at most one document.

Returns:

True if the operation should only delete at most one document.

toString

public String toString()

Overridden to returns a representation of the delete.

Overrides:

toString in class Object