Class BasicUpdate

java.lang.Object

org.springframework.data.mongodb.core.query.Update

org.springframework.data.mongodb.core.query.BasicUpdate

All Implemented Interfaces:

UpdateDefinition

public class BasicUpdate
extends Update

Author:

Thomas Risberg, John Brisbin, Oliver Gierke, Christoph Strobl, Mark Paluch

Nested Class Summary

Nested classes/interfaces inherited from class Update

Update.AddToSetBuilder, Update.BitwiseOperatorBuilder, Update.Modifier, Update.Modifiers, Update.Position, Update.PushOperatorBuilder

Nested classes/interfaces inherited from interface UpdateDefinition

UpdateDefinition.ArrayFilter

Constructor Summary

Constructors

Constructor	Description
BasicUpdate(String updateString)
BasicUpdate(org.bson.Document updateObject)

Method Summary

Modifier and Type	Method	Description
Update	addToSet(String key, @Nullable Object value)	Update using the $addToSet update modifier.
org.bson.Document	getUpdateObject()
Update	inc(String key, Number inc)	Update using the $inc update modifier.
boolean	modifies(String key)	Determine if a given key will be touched on execution.
Update	pop(String key, Update.Position pos)	Update using the $pop update modifier.
Update	pull(String key, @Nullable Object value)	Update using the $pull update modifier.
Update	pullAll(String key, Object[] values)	Update using the $pullAll update modifier.
Update	push(String key, @Nullable Object value)	Update using the $push update modifier.
Update	rename(String oldName, String newName)	Update using the $rename update modifier.
Update	set(String key, @Nullable Object value)	Update using the $set update modifier.
Update	unset(String key)	Update using the $unset update modifier.

Methods inherited from class Update

addMultiFieldOperation, addToSet, bitwise, currentDate, currentTimestamp, equals, filterArray, filterArray, fromDocument, getArrayFilters, hasArrayFilters, hashCode, inc, isIsolated, isolated, max, min, multiply, push, setOnInsert, toString, update

Methods inherited from class Object

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

Constructor Details

BasicUpdate

public BasicUpdate(String updateString)

BasicUpdate

public BasicUpdate(org.bson.Document updateObject)

Method Details

set

@Contract("_, _ -> this")
public Update set(String key,
 @Nullable Object value)

Description copied from class: Update

Update using the $set update modifier.

Overrides:

set in class Update

Parameters:

key - the field name.

value - can be null. In this case the property remains in the db with a null value. To remove it use Update.unset(String).

Returns:

this.

See Also:

• MongoDB Update operator: $set

unset

@Contract("_ -> this")
public Update unset(String key)

Description copied from class: Update

Update using the $unset update modifier.

Overrides:

unset in class Update

Parameters:

key - the field name.

Returns:

this.

See Also:

• MongoDB Update operator: $unset

inc

@Contract("_, _ -> this")
public Update inc(String key,
 Number inc)

Description copied from class: Update

Update using the $inc update modifier.

Overrides:

inc in class Update

Parameters:

key - the field name.

inc - must not be null.

Returns:

this.

See Also:

• MongoDB Update operator: $inc

push

@Contract("_, _ -> this")
public Update push(String key,
 @Nullable Object value)

Description copied from class: Update

Update using the $push update modifier.

Overrides:

push in class Update

Parameters:

key - the field name.

value - can be null.

Returns:

this.

See Also:

• MongoDB Update operator: $push

addToSet

@Contract("_, _ -> this")
public Update addToSet(String key,
 @Nullable Object value)

Description copied from class: Update

Update using the $addToSet update modifier.

Overrides:

addToSet in class Update

Parameters:

key - the field name.

value - can be null.

Returns:

this.

See Also:

• MongoDB Update operator: $addToSet

pop

@Contract("_, _ -> this")
public Update pop(String key,
 Update.Position pos)

Description copied from class: Update

Update using the $pop update modifier.

Overrides:

pop in class Update

Parameters:

key - the field name.

pos - must not be null.

Returns:

this.

See Also:

• MongoDB Update operator: $pop

pull

@Contract("_, _ -> this")
public Update pull(String key,
 @Nullable Object value)

Description copied from class: Update

Update using the $pull update modifier.

Overrides:

pull in class Update

Parameters:

key - the field name.

value - can be null.

Returns:

this.

See Also:

• MongoDB Update operator: $pull

pullAll

@Contract("_, _ -> this")
public Update pullAll(String key,
 Object[] values)

Description copied from class: Update

Update using the $pullAll update modifier.

Overrides:

pullAll in class Update

Parameters:

key - the field name.

values - must not be null.

Returns:

this.

See Also:

• MongoDB Update operator: $pullAll

rename

@Contract("_, _ -> this")
public Update rename(String oldName,
 String newName)

Description copied from class: Update

Update using the $rename update modifier.

Overrides:

rename in class Update

Parameters:

oldName - must not be null.

newName - must not be null.

Returns:

this.

See Also:

• MongoDB Update operator: $rename

modifies

public boolean modifies(String key)

Description copied from class: Update

Determine if a given key will be touched on execution.

Specified by:

modifies in interface UpdateDefinition

Overrides:

modifies in class Update

Parameters:

key - the field name.

Returns:

true if given field is updated.

getUpdateObject

public org.bson.Document getUpdateObject()

Specified by:

getUpdateObject in interface UpdateDefinition

Overrides:

getUpdateObject in class Update

Returns:

the actual update in its native Document format. Never null.