Package dev.morphia.query

Interface Updates<Updater extends Updates>

Type Parameters:

Updater -

All Known Implementing Classes:

Modify, Update, UpdateBase

public interface Updates<Updater extends Updates>

Defines the update operations available

Method Summary

Modifier and Type	Method	Description
Updater	addToSet(String field, Iterable<?> values)	adds the values to an array field if they doesn't already exist in the array
Updater	addToSet(String field, Object value)	adds the value to an array field if it doesn't already exist in the array
Updater	addToSet(String field, List<?> values)	adds the values to an array field if they doesn't already exist in the array
Updater	dec(String field)	Decrements the numeric field by 1
Updater	dec(String field, Number value)	Decrements the numeric field by value (must be a positive Double, Float, Long, or Integer).
Updater	disableValidation()	Turns off validation (for all calls made after)
Updater	enableValidation()	Turns on validation (for all calls made after); by default validation is on
Updater	inc(String field)	Increments the numeric field by 1
Updater	inc(String field, Number value)	increments the numeric field by value (negatives are allowed)
Updater	max(String field, Number value)	Sets the numeric field to value if it is greater than the current value.
Updater	min(String field, Number value)	sets the numeric field to value if it is less than the current value.
Updater	pull(String field, Object value)	removes the value from the array field
Updater	pullAll(String field, List<?> values)	removes the values from the array field
Updater	push(String field, Object value)	Adds new values to an array field.
Updater	push(String field, Object value, PushOptions options)	Adds new values to an array field at the given position
Updater	push(String field, List<?> values)	Adds new values to an array field.
Updater	push(String field, List<?> values, PushOptions options)	Adds new values to an array field at the given position
Updater	removeAll(String field, Object value)	Deprecated, for removal: This API element is subject to removal in a future version. use pull(String, Object) instead
Updater	removeAll(String field, List<?> values)	Deprecated, for removal: This API element is subject to removal in a future version. use pullAll(String, List) instead
Updater	removeFirst(String field)	removes the first value from the array
Updater	removeLast(String field)	removes the last value from the array
Updater	set(Object entity)	sets the entity value to completely replace the stored document
Updater	set(String field, Object value)	sets the field value
Updater	setOnInsert(String field, Object value)	sets the field on insert.
Updater	unset(String field)	removes the field

Method Detail

addToSet

Updater addToSet(String field,
                 Object value)

adds the value to an array field if it doesn't already exist in the array

Parameters:

field - the field to update

value - the value to add

Returns:

this

MongoDB documentation

reference/operator/update/addToSet/ $addToSet

addToSet

Updater addToSet(String field,
                 List<?> values)

adds the values to an array field if they doesn't already exist in the array

Parameters:

field - the field to update

values - the values to add

Returns:

this

MongoDB documentation

reference/operator/update/addToSet/ $addToSet

addToSet

Updater addToSet(String field,
                 Iterable<?> values)

adds the values to an array field if they doesn't already exist in the array

Parameters:

field - the field to update

values - the values to add

Returns:

this

MongoDB documentation

reference/operator/update/addToSet/ $addToSet

dec

Updater dec(String field)

Decrements the numeric field by 1

Parameters:

field - the field to update

Returns:

this

MongoDB documentation

reference/operator/update/inc/ $inc

dec

Updater dec(String field,
            Number value)

Decrements the numeric field by value (must be a positive Double, Float, Long, or Integer).

Parameters:

field - the field to update

value - the value to decrement by

Returns:

this

Throws:

IllegalArgumentException - of the value is not an instance of Double, Float,Long, or Integer

MongoDB documentation

reference/operator/update/inc/ $inc

disableValidation

Updater disableValidation()

Turns off validation (for all calls made after)

Returns:

this

enableValidation

Updater enableValidation()

Turns on validation (for all calls made after); by default validation is on

Returns:

this

inc

Updater inc(String field)

Increments the numeric field by 1

Parameters:

field - the field to update

Returns:

this

MongoDB documentation

reference/operator/update/inc/ $inc

inc

Updater inc(String field,
            Number value)

increments the numeric field by value (negatives are allowed)

Parameters:

field - the field to update

value - the value to increment by

Returns:

this

MongoDB documentation

reference/operator/update/inc/ $inc

max

Updater max(String field,
            Number value)

Sets the numeric field to value if it is greater than the current value.

Parameters:

field - the field to update

value - the value to use

Returns:

this

MongoDB documentation

reference/operator/update/max/ $max

min

Updater min(String field,
            Number value)

sets the numeric field to value if it is less than the current value.

Parameters:

field - the field to update

value - the value to use

Returns:

this

MongoDB documentation

reference/operator/update/min/ $min

pull

Updater pull(String field,
             Object value)

removes the value from the array field

Parameters:

field - the field to update

value - the value to use

Returns:

this

MongoDB documentation

reference/operator/update/pull/ $pull

pullAll

Updater pullAll(String field,
                List<?> values)

removes the values from the array field

Parameters:

field - the field to update

values - the values to use

Returns:

this

MongoDB documentation

reference/operator/update/pullAll/ $pullAll

push

Updater push(String field,
             Object value)

Adds new values to an array field.

Parameters:

field - the field to updated

value - the value to add

Returns:

this

MongoDB documentation

reference/operator/update/push/ $push

push

Updater push(String field,
             Object value,
             PushOptions options)

Adds new values to an array field at the given position

Parameters:

field - the field to updated

value - the value to add

options - the options to apply to the push

Returns:

this

MongoDB documentation

reference/operator/update/push/ $push

push

Updater push(String field,
             List<?> values)

Adds new values to an array field.

Parameters:

field - the field to updated

values - the values to add

Returns:

this

MongoDB documentation

reference/operator/update/push/ $push

push

Updater push(String field,
             List<?> values,
             PushOptions options)

Adds new values to an array field at the given position

Parameters:

field - the field to updated

values - the values to add

options - the options to apply to the push

Returns:

this

MongoDB documentation

reference/operator/update/push/ $push

removeAll

@Deprecated(since="2.0",
            forRemoval=true)
Updater removeAll(String field,
                  Object value)

Deprecated, for removal: This API element is subject to removal in a future version.

use pull(String, Object) instead

removes the value from the array field

Parameters:

field - the field to update

value - the value to use

Returns:

this

MongoDB documentation

reference/operator/update/pull/ $pull

removeAll

@Deprecated(since="2.0",
            forRemoval=true)
Updater removeAll(String field,
                  List<?> values)

Deprecated, for removal: This API element is subject to removal in a future version.

use pullAll(String, List) instead

removes the values from the array field

Parameters:

field - the field to update

values - the values to use

Returns:

this

MongoDB documentation

reference/operator/update/pullAll/ $pullAll

removeFirst

Updater removeFirst(String field)

removes the first value from the array

Parameters:

field - the field to update

Returns:

this

MongoDB documentation

reference/operator/update/pop/ $pop

removeLast

Updater removeLast(String field)

removes the last value from the array

Parameters:

field - the field to update

Returns:

this

MongoDB documentation

reference/operator/update/pop/ $pop

set

Updater set(String field,
            Object value)

sets the field value

Parameters:

field - the field to update

value - the value to use

Returns:

this

MongoDB documentation

reference/operator/update/set/ $set

set

Updater set(Object entity)

sets the entity value to completely replace the stored document

Parameters:

entity - the entity to store

Returns:

this

MongoDB documentation

reference/operator/update/set/ $set

setOnInsert

Updater setOnInsert(String field,
                    Object value)

sets the field on insert.

Parameters:

field - the field to update

value - the value to use

Returns:

this

MongoDB documentation

reference/operator/update/setOnInsert/ $setOnInsert

unset

Updater unset(String field)

removes the field

Parameters:

field - the field to update

Returns:

this

MongoDB documentation

reference/operator/update/unset/ $unset