com.allanbank.mongodb.builder.write

Class InsertOperation

java.lang.Object

com.allanbank.mongodb.builder.write.InsertOperation

All Implemented Interfaces:

WriteOperation, Serializable

public class InsertOperation
extends Object
implements WriteOperation

InsertOperation provides a container for the fields in an insert 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
InsertOperation(DocumentAssignable document) Creates a new InsertOperation.

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	getDocument() Returns the document to insert.
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.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

InsertOperation

public InsertOperation(DocumentAssignable document)

Creates a new InsertOperation.

Parameters:

document - The document to insert.

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)

getDocument

public Document getDocument()

Returns the document to insert.

Returns:

The document to insert.

getRoutingDocument

public Document getRoutingDocument()

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

Overridden to return the document to insert.

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

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.

toString

public String toString()

Overridden to returns a representation of the update.

Overrides:

toString in class Object