com.allanbank.mongodb.builder

Class FindAndModify.Builder

java.lang.Object

com.allanbank.mongodb.builder.FindAndModify.Builder

Enclosing class:

FindAndModify

public static class FindAndModify.Builder
extends Object

Helper for creating immutable FindAndModify commands.

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

Field Summary

Fields

Modifier and Type	Field and Description
protected Document	myFields Retrieve a subset of fields from the matched document.
protected long	myMaximumTimeMilliseconds The maximum amount of time to allow the command to run.
protected Document	myQuery A query to locate the document to update.
protected boolean	myRemove Set to a true to remove the object before returning
protected boolean	myReturnNew Set to true if you want to return the modified object rather than the original.
protected Document	mySort If multiple docs match, choose the first one in the specified sort order as the object to manipulate.
protected Document	myUpdate Updates to be applied to the document.
protected boolean	myUpsert Create object if it doesn't exist.

Constructor Summary

Constructors

Constructor and Description
FindAndModify.Builder() Creates a new Builder.

Method Summary

Methods

Modifier and Type	Method and Description
FindAndModify	build() Constructs a new FindAndModify object from the state of the builder.
FindAndModify.Builder	fields(DocumentAssignable fields) Sets the subset of fields to retrieve from the matched document.
FindAndModify.Builder	maximumTime(long timeLimit, TimeUnit timeLimitUnits) Sets the maximum number of milliseconds to allow the command to run before aborting the request on the server.
FindAndModify.Builder	query(DocumentAssignable query) Sets the query to locate the document to update.
FindAndModify.Builder	remove() Sets to true if the document should be removed.
FindAndModify.Builder	remove(boolean remove) Sets to true if the document should be removed.
FindAndModify.Builder	reset() Resets the builder back to its initial state.
FindAndModify.Builder	returnNew() Sets to true if the updated document should be returned instead of the document before the update.
FindAndModify.Builder	returnNew(boolean returnNew) Sets to true if the updated document should be returned instead of the document before the update.
FindAndModify.Builder	setFields(DocumentAssignable fields) Sets the subset of fields to retrieve from the matched document.
FindAndModify.Builder	setMaximumTimeMilliseconds(long maximumTimeMilliseconds) Sets the maximum number of milliseconds to allow the command to run before aborting the request on the server.
FindAndModify.Builder	setQuery(DocumentAssignable query) Sets the query to locate the document to update.
FindAndModify.Builder	setRemove(boolean remove) Sets to true if the document should be removed.
FindAndModify.Builder	setReturnNew(boolean returnNew) Sets to true if the updated document should be returned instead of the document before the update.
FindAndModify.Builder	setSort(DocumentAssignable sort) Sets the sort to apply if multiple docs match, choose the first one as the object to manipulate.
FindAndModify.Builder	setSort(IntegerElement... sortFields) Sets the sort to apply if multiple docs match, choose the first one as the object to manipulate.
FindAndModify.Builder	setUpdate(DocumentAssignable update) Sets the updates to be applied to the document.
FindAndModify.Builder	setUpsert(boolean upsert) Sets to true to create the document if it doesn't exist.
FindAndModify.Builder	sort(DocumentAssignable sort) Sets the sort to apply if multiple docs match, choose the first one as the object to manipulate.
FindAndModify.Builder	sort(IntegerElement... sortFields) Sets the sort to apply if multiple docs match, choose the first one as the object to manipulate.
FindAndModify.Builder	update(DocumentAssignable update) Sets the updates to be applied to the document.
FindAndModify.Builder	upsert() Sets to true to create the document if it doesn't exist.
FindAndModify.Builder	upsert(boolean upsert) Sets to 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

myFields

protected Document myFields

Retrieve a subset of fields from the matched document.

myMaximumTimeMilliseconds

protected long myMaximumTimeMilliseconds

The maximum amount of time to allow the command to run.

myQuery

protected Document myQuery

A query to locate the document to update.

myRemove

protected boolean myRemove

Set to a true to remove the object before returning

myReturnNew

protected boolean myReturnNew

Set to true if you want to return the modified object rather than the original. Ignored for remove.

mySort

protected Document mySort

If multiple docs match, choose the first one in the specified sort order as the object to manipulate.

myUpdate

protected Document myUpdate

Updates to be applied to the document.

myUpsert

protected boolean myUpsert

Create object if it doesn't exist.

Constructor Detail

FindAndModify.Builder

public FindAndModify.Builder()

Creates a new Builder.

Method Detail

build

public FindAndModify build()

Constructs a new FindAndModify object from the state of the builder.

Returns:

The new FindAndModify object.

fields

public FindAndModify.Builder fields(DocumentAssignable fields)

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

This method delegates to setFields(DocumentAssignable).

Parameters:

fields - The subset of fields to retrieve from the matched document.

Returns:

This builder for chaining method calls.

maximumTime

public FindAndModify.Builder maximumTime(long timeLimit,
                                TimeUnit timeLimitUnits)

Sets the maximum number of milliseconds to allow the command to run before aborting the request on the server.

This method equivalent to setMaximumTimeMilliseconds(timeLimitUnits.toMillis(timeLimit).

Parameters:

timeLimit - The new maximum amount of time to allow the command to run.

timeLimitUnits - The units for the maximum amount of time to allow the command to run.

Returns:

This FindAndModify.Builder for method call chaining.

Since:

MongoDB 2.6

query

public FindAndModify.Builder query(DocumentAssignable query)

Sets the query to locate the document to update.

This method delegates to setQuery(DocumentAssignable).

Parameters:

query - The query to locate the document to update.

Returns:

This builder for chaining method calls.

remove

public FindAndModify.Builder remove()

Sets to true if the document should be removed.

This method delegates to setRemove(true).

Returns:

This builder for chaining method calls.

remove

public FindAndModify.Builder remove(boolean remove)

Sets to true if the document should be removed.

This method delegates to setRemove(boolean).

Parameters:

remove - True if the document should be removed.

Returns:

This builder for chaining method calls.

reset

public FindAndModify.Builder reset()

Resets the builder back to its initial state.

Returns:

This FindAndModify.Builder for method call chaining.

returnNew

public FindAndModify.Builder returnNew()

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

This method delegates to setReturnNew(true).

Returns:

This builder for chaining method calls.

returnNew

public FindAndModify.Builder returnNew(boolean returnNew)

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

This method delegates to setReturnNew(boolean).

Parameters:

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

Returns:

This builder for chaining method calls.

setFields

public FindAndModify.Builder setFields(DocumentAssignable fields)

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

Parameters:

fields - The subset of fields to retrieve from the matched document.

Returns:

This builder for chaining method calls.

setMaximumTimeMilliseconds

public FindAndModify.Builder setMaximumTimeMilliseconds(long maximumTimeMilliseconds)

Sets the maximum number of milliseconds to allow the command to run before aborting the request on the server.

Parameters:

maximumTimeMilliseconds - The new maximum number of milliseconds to allow the command to run.

Returns:

This FindAndModify.Builder for method call chaining.

Since:

MongoDB 2.6

setQuery

public FindAndModify.Builder setQuery(DocumentAssignable query)

Sets the query to locate the document to update.

Parameters:

query - The query to locate the document to update.

Returns:

This builder for chaining method calls.

setRemove

public FindAndModify.Builder setRemove(boolean remove)

Sets to true if the document should be removed.

Parameters:

remove - True if the document should be removed.

Returns:

This builder for chaining method calls.

setReturnNew

public FindAndModify.Builder setReturnNew(boolean returnNew)

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

Parameters:

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

Returns:

This builder for chaining method calls.

setSort

public FindAndModify.Builder setSort(DocumentAssignable sort)

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

Parameters:

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

Returns:

This builder for chaining method calls.

setSort

public FindAndModify.Builder setSort(IntegerElement... sortFields)

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

This method is intended to be used with the Sort class's static methods:

 
 import static com.allanbank.mongodb.builder.Sort.asc;
 import static com.allanbank.mongodb.builder.Sort.desc;
 
 FindAndModify.Builder builder = new Find.Builder();
 
 builder.setSort( asc("f"), desc("g") );
 ...
 
 

Parameters:

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

Returns:

This builder for chaining method calls.

setUpdate

public FindAndModify.Builder setUpdate(DocumentAssignable update)

Sets the updates to be applied to the document.

Parameters:

update - The updates to be applied to the document.

Returns:

This builder for chaining method calls.

setUpsert

public FindAndModify.Builder setUpsert(boolean upsert)

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

Parameters:

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

Returns:

This builder for chaining method calls.

sort

public FindAndModify.Builder sort(DocumentAssignable sort)

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

This method delegates to setSort(DocumentAssignable).

Parameters:

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

Returns:

This builder for chaining method calls.

sort

public FindAndModify.Builder sort(IntegerElement... sortFields)

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

This method delegates to setSort(IntegerElement...).

This method is intended to be used with the Sort class's static methods:

 
 import static com.allanbank.mongodb.builder.Sort.asc;
 import static com.allanbank.mongodb.builder.Sort.desc;
 
 FindAndModify.Builder builder = new Find.Builder();
 
 builder.sort( asc("f"), desc("g") );
 ...
 
 

Parameters:

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

Returns:

This builder for chaining method calls.

update

public FindAndModify.Builder update(DocumentAssignable update)

Sets the updates to be applied to the document.

This method delegates to setUpdate(DocumentAssignable).

Parameters:

update - The updates to be applied to the document.

Returns:

This builder for chaining method calls.

upsert

public FindAndModify.Builder upsert()

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

This method delegates to setUpsert(true).

Returns:

This builder for chaining method calls.

upsert

public FindAndModify.Builder upsert(boolean upsert)

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

This method delegates to setUpsert(boolean).

Parameters:

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

Returns:

This builder for chaining method calls.