net.vz.mongodb.jackson
Class DBUpdate

java.lang.Object
  net.vz.mongodb.jackson.DBUpdate

public class DBUpdate
extends Object

A database update. This can be used to build queries using the MongoDB modifier operations. It also will do serialisation of values, however it won't honour any custom serialisers specified on the fields that those values are being set.

Since:

1.1

Author:

James Roper

Nested Class Summary

static class

DBUpdate.Builder The builder

Constructor Summary

DBUpdate()

Method Summary

static DBUpdate.Builder	addToSet(String field, List<?> values) Add the given values to the array value if they don't already exist in the specified field atomically
static DBUpdate.Builder	addToSet(String field, Object... values) Add the given values to the array value if they don't already exist in the specified field atomically
static DBUpdate.Builder	addToSet(String field, Object value) Add the given value to the array value if it doesn't already exist in the specified field atomically
static DBUpdate.Builder	bit(String field, String operation, int value) Perform a bit operation on the given field
static DBUpdate.Builder	bit(String field, String operation1, int value1, String operation2, int value2) Perform two bit operations on the given field
static DBUpdate.Builder	bitwiseAnd(String field, int value) Perform a bitwise and on the given field
static DBUpdate.Builder	bitwiseOr(String field, int value) Perform a bitwise or on the given field
static DBUpdate.Builder	inc(String field) Increment the given field atomically by one
static DBUpdate.Builder	inc(String field, int by) Increment the given field atomically by the given value
static DBUpdate.Builder	popFirst(String field) Remove the first value from the array specified by field atomically
static DBUpdate.Builder	popLast(String field) Remove the last value from the array specified by field atomically
static DBUpdate.Builder	pull(String field, Object value) Remove all occurances of value from the array at field
static DBUpdate.Builder	pullAll(String field, List<?> values) Remove all occurances of the values from the array at field
static DBUpdate.Builder	pullAll(String field, Object... values) Remove all occurances of the values from the array at field
static DBUpdate.Builder	push(String field, Object value) Add the given value to the array value at the specified field atomically
static DBUpdate.Builder	pushAll(String field, List<?> values) Add all of the given values to the array value at the specified field atomically
static DBUpdate.Builder	pushAll(String field, Object... values) Add all of the given values to the array value at the specified field atomically
static DBUpdate.Builder	rename(String oldFieldName, String newFieldName) Rename the given field to the new field name
static DBUpdate.Builder	set(String field, Object value) Set the given field (can be multiple levels deep) to the given value atomically
static DBUpdate.Builder	unset(String field) Unset the given field atomically

Methods inherited from class java.lang.Object

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

Constructor Detail

DBUpdate

public DBUpdate()

Method Detail

inc

public static DBUpdate.Builder inc(String field)

Increment the given field atomically by one

Parameters:

field - The field to increment

Returns:

this object

inc

public static DBUpdate.Builder inc(String field,
                                   int by)

Increment the given field atomically by the given value

Parameters:

field - The field to increment

by - The value to increment by

Returns:

this object

set

public static DBUpdate.Builder set(String field,
                                   Object value)

Set the given field (can be multiple levels deep) to the given value atomically

Parameters:

field - The field to set

value - The value to set it to

Returns:

this object

unset

public static DBUpdate.Builder unset(String field)

Unset the given field atomically

Parameters:

field - The field to unset

Returns:

this object

push

public static DBUpdate.Builder push(String field,
                                    Object value)

Add the given value to the array value at the specified field atomically

Parameters:

field - The field to add the value to

value - The value to add

Returns:

this object

pushAll

public static DBUpdate.Builder pushAll(String field,
                                       Object... values)

Add all of the given values to the array value at the specified field atomically

Parameters:

field - The field to add the values to

values - The values to add

Returns:

this object

pushAll

public static DBUpdate.Builder pushAll(String field,
                                       List<?> values)

Add all of the given values to the array value at the specified field atomically

Parameters:

field - The field to add the values to

values - The values to add

Returns:

this object

addToSet

public static DBUpdate.Builder addToSet(String field,
                                        Object value)

Add the given value to the array value if it doesn't already exist in the specified field atomically

Parameters:

field - The field to add the value to

value - The value to add

Returns:

this object

addToSet

public static DBUpdate.Builder addToSet(String field,
                                        Object... values)

Add the given values to the array value if they don't already exist in the specified field atomically

Parameters:

field - The field to add the values to

values - The values to add

Returns:

this object

addToSet

public static DBUpdate.Builder addToSet(String field,
                                        List<?> values)

Add the given values to the array value if they don't already exist in the specified field atomically

Parameters:

field - The field to add the values to

values - The values to add

Returns:

this object

popFirst

public static DBUpdate.Builder popFirst(String field)

Remove the first value from the array specified by field atomically

Parameters:

field - The field to remove the value from

Returns:

this object

popLast

public static DBUpdate.Builder popLast(String field)

Remove the last value from the array specified by field atomically

Parameters:

field - The field to remove the value from

Returns:

this object

pull

public static DBUpdate.Builder pull(String field,
                                    Object value)

Remove all occurances of value from the array at field

Parameters:

field - The field to remove the value from

value - The value to remove. This may be another query.

Returns:

this object

pullAll

public static DBUpdate.Builder pullAll(String field,
                                       Object... values)

Remove all occurances of the values from the array at field

Parameters:

field - The field to remove the values from

values - The values to remove

Returns:

this object

pullAll

public static DBUpdate.Builder pullAll(String field,
                                       List<?> values)

Remove all occurances of the values from the array at field

Parameters:

field - The field to remove the values from

values - The values to remove

Returns:

this object

rename

public static DBUpdate.Builder rename(String oldFieldName,
                                      String newFieldName)

Rename the given field to the new field name

Parameters:

oldFieldName - The old field name

newFieldName - The new field name

Returns:

this object

bit

public static DBUpdate.Builder bit(String field,
                                   String operation,
                                   int value)

Perform a bit operation on the given field

Parameters:

field - The field to perform the operation on

operation - The operation to perform

value - The value

Returns:

this object

bit

public static DBUpdate.Builder bit(String field,
                                   String operation1,
                                   int value1,
                                   String operation2,
                                   int value2)

Perform two bit operations on the given field

Parameters:

field - The field to perform the operations on

operation1 - The first operation to perform

value1 - The first value

operation2 - The second operation to perform

value2 - The second value

Returns:

this object

bitwiseAnd

public static DBUpdate.Builder bitwiseAnd(String field,
                                          int value)

Perform a bitwise and on the given field

Parameters:

field - The field to perform the and on

value - The value

Returns:

this object

bitwiseOr

public static DBUpdate.Builder bitwiseOr(String field,
                                         int value)

Perform a bitwise or on the given field

Parameters:

field - The field to perform the or on

value - The value

Returns:

this object