org.springframework.data.mongodb.core.query

Interface UpdateDefinition

All Known Implementing Classes:

BasicUpdate, Update

public interface UpdateDefinition

Interface fixing must have operations for updates as implemented via Update.

Since:

2.1.4

Author:

Christoph Strobl, Mark Paluch

Method Summary

Modifier and Type	Method and Description
org.bson.Document	getUpdateObject()
void	inc(String key) Increment the value of a given key by 1.
Boolean	isIsolated() If true prevents a write operation that affects multiple documents from yielding to other reads or writes once the first document is written.
boolean	modifies(String key) Check if a given key is modified by applying the update.

Method Detail

isIsolated

Boolean isIsolated()

If true prevents a write operation that affects multiple documents from yielding to other reads or writes once the first document is written.

Returns:

true if update isolated is set.

getUpdateObject

org.bson.Document getUpdateObject()

Returns:

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

modifies

boolean modifies(String key)

Check if a given key is modified by applying the update.

Parameters:

key - must not be null.

Returns:

true if the actual UpdateDefinition attempts to modify the given key.

inc

void inc(String key)

Increment the value of a given key by 1.

Parameters:

key - must not be null.