com.allanbank.mongodb.builder.write

Class UpdateOperation

java.lang.Object

com.allanbank.mongodb.builder.write.UpdateOperation

All Implemented Interfaces:

WriteOperation, Serializable

public class UpdateOperation
extends Object
implements WriteOperation

UpdateOperation provides a container for the fields in an update 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
UpdateOperation(DocumentAssignable query, DocumentAssignable update, boolean multiUpdate, boolean upsert) Creates a new UpdateOperation.

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 update.
Document	getRoutingDocument() Returns the document that should be used to route the write operation.
WriteOperationType	getType() Returns the type of write.
Document	getUpdate() Returns the update specification.
int	hashCode() Computes a reasonable hash code.
boolean	isMultiUpdate() Returns true if the update can modify multiple documents.
boolean	isUpsert() Returns true if the document should be inserted if not found.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateOperation

public UpdateOperation(DocumentAssignable query,
               DocumentAssignable update,
               boolean multiUpdate,
               boolean upsert)

Creates a new UpdateOperation.

Parameters:

query - The query to find the documents to update.

update - The update specification.

multiUpdate - If true then the update is applied to all of the matching documents, otherwise only the first document found is updated.

upsert - If true then if no document is found then a new document is created and updated, otherwise no operation is performed.

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 update.

Returns:

The query to find the documents to update.

getRoutingDocument

public Document getRoutingDocument()

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

Overridden to return the query for the update.

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.UPDATE.

Specified by:

getType in interface WriteOperation

Returns:

The type of write.

getUpdate

public Document getUpdate()

Returns the update specification.

Returns:

The update specification.

hashCode

public int hashCode()

Computes a reasonable hash code.

Overrides:

hashCode in class Object

Returns:

The hash code value.

isMultiUpdate

public boolean isMultiUpdate()

Returns true if the update can modify multiple documents.

Returns:

True if the update can modify multiple documents.

isUpsert

public boolean isUpsert()

Returns true if the document should be inserted if not found.

Returns:

True if the document should be inserted if not found.

toString

public String toString()

Overridden to returns a representation of the update.

Overrides:

toString in class Object