com.allanbank.mongodb.builder

Class FindAndModify

java.lang.Object

com.allanbank.mongodb.builder.FindAndModify

public class FindAndModify
extends Object

Represents the state of a single MongoCollection.findAndModify(com.allanbank.mongodb.builder.FindAndModify) command. Objects of this class are created using the nested FindAndModify.Builder.

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

2011-2013, Allanbank Consulting, Inc., All Rights Reserved

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FindAndModify.Builder Helper for creating immutable FindAndModify commands.

Field Summary

Fields

Modifier and Type	Field and Description
static Document	ALL An (empty) query document to find all documents.
static Version	MAX_TIMEOUT_VERSION The first version of MongoDB to support the findAndModify command with the ability to limit the execution time on the server.
static Document	NONE An (empty) update document to perform no actual modifications.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FindAndModify(FindAndModify.Builder builder) Create a new FindAndModify.

Method Summary

Methods

Modifier and Type	Method and Description
static FindAndModify.Builder	builder() Creates a new builder for a FindAndModify.
Document	getFields() Returns the subset of fields to retrieve from the matched document.
long	getMaximumTimeMilliseconds() Returns the maximum amount of time to allow the command to run on the Server before it is aborted.
Document	getQuery() Returns the query to locate the document to update.
Document	getSort() Returns the sort to apply if multiple docs match, choose the first one as the object to manipulate.
Document	getUpdate() Returns the updates to be applied to the document.
boolean	isRemove() Returns true if the document should be removed.
boolean	isReturnNew() Returns true if the updated document should be returned instead of the document before the update.
boolean	isUpsert() Returns true to create the document if it doesn't exist.

Methods inherited from class java.lang.Object

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

Field Detail

ALL

public static final Document ALL

An (empty) query document to find all documents.

MAX_TIMEOUT_VERSION

public static final Version MAX_TIMEOUT_VERSION

The first version of MongoDB to support the findAndModify command with the ability to limit the execution time on the server.

NONE

public static final Document NONE

An (empty) update document to perform no actual modifications.

Constructor Detail

FindAndModify

protected FindAndModify(FindAndModify.Builder builder)

Create a new FindAndModify.

Parameters:

builder - The builder to copy from.

Method Detail

builder

public static FindAndModify.Builder builder()

Creates a new builder for a FindAndModify.

Returns:

The builder to construct a FindAndModify.

getFields

public Document getFields()

Returns the subset of fields to retrieve from the matched document.

Returns:

The subset of fields to retrieve from the matched document.

getMaximumTimeMilliseconds

public long getMaximumTimeMilliseconds()

Returns the maximum amount of time to allow the command to run on the Server before it is aborted.

Returns:

The maximum amount of time to allow the command to run on the Server before it is aborted.

Since:

MongoDB 2.6

getQuery

public Document getQuery()

Returns the query to locate the document to update.

Returns:

The query to locate the document to update.

getSort

public Document getSort()

Returns the sort to apply if multiple docs match, choose the first one as the object to manipulate.

Returns:

The sort to apply if multiple docs match, choose the first one as the object to manipulate.

getUpdate

public Document getUpdate()

Returns the updates to be applied to the document.

Returns:

The updates to be applied to the document.

isRemove

public boolean isRemove()

Returns true if the document should be removed.

Returns:

True if the document should be removed.

isReturnNew

public boolean isReturnNew()

Returns true if the updated document should be returned instead of the document before the update.

Returns:

True if the updated document should be returned instead of the document before the update.

isUpsert

public boolean isUpsert()

Returns true to create the document if it doesn't exist.

Returns:

True to create the document if it doesn't exist.