Package com.couchbase.client.java.kv
Class MutationState
- java.lang.Object
-
- com.couchbase.client.java.kv.MutationState
-
- All Implemented Interfaces:
Iterable<MutationToken>
public class MutationState extends Object implements Iterable<MutationToken>
Aggregation of one or moreMutationTokens for specifying consistency requirements of N1QL or FTS queries.Thread-safe.
- Since:
- 2.3.0
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description MutationStateadd(MutationToken... mutationTokens)Add one or moreMutationTokensto thisMutationState.MutationStateadd(MutationState mutationState)Adds all the internal state from the givenMutationStateonto the called one.booleanequals(Object o)JsonObjectexport()Exports theMutationStateinto a universal format, which can be used either to serialize it into a N1QL query or to send it over the network to a different application/SDK.JsonObjectexportForSearch()Exports theMutationStateinto a format recognized by the FTS search engine.static MutationStatefrom(MutationToken... mutationTokens)Create aMutationStatefrom one or moreMutationTokens.static MutationStatefrom(JsonObject source)Create aMutationStatefrom the serialized state.static MutationStatefrom(String source)Create aMutationStatefrom the serialized state.inthashCode()Iterator<MutationToken>iterator()StringtoString()-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
-
-
-
Method Detail
-
from
public static MutationState from(MutationToken... mutationTokens)
Create aMutationStatefrom one or moreMutationTokens.- Parameters:
mutationTokens- the mutation tokens.- Returns:
- the initialized
MutationState.
-
add
public MutationState add(MutationToken... mutationTokens)
Add one or moreMutationTokensto thisMutationState.- Parameters:
mutationTokens- the tokens- Returns:
- the modified
MutationState.
-
add
public MutationState add(MutationState mutationState)
Adds all the internal state from the givenMutationStateonto the called one.- Parameters:
mutationState- the state from which the tokens are applied from.- Returns:
- the modified
MutationState.
-
iterator
public Iterator<MutationToken> iterator()
- Specified by:
iteratorin interfaceIterable<MutationToken>
-
export
public JsonObject export()
Exports theMutationStateinto a universal format, which can be used either to serialize it into a N1QL query or to send it over the network to a different application/SDK.- Returns:
- the exported
JsonObject.
-
exportForSearch
public JsonObject exportForSearch()
Exports theMutationStateinto a format recognized by the FTS search engine.- Returns:
- the exported
JsonObjectfor one FTS index.
-
from
public static MutationState from(String source)
Create aMutationStatefrom the serialized state.- Parameters:
source- the source state, serialized.- Returns:
- the created
MutationState.
-
from
public static MutationState from(JsonObject source)
Create aMutationStatefrom the serialized state.- Parameters:
source- the source state, serialized.- Returns:
- the created
MutationState.
-
-