Package com.couchbase.client.java
Class MutationState
- java.lang.Object
-
- com.couchbase.client.java.MutationState
-
- All Implemented Interfaces:
Iterable<MutationToken>
public class MutationState extends Object implements Iterable<MutationToken>
Aggregation of one or moreMutationToken
into oneMutationState
.- Since:
- 2.3.0
- Author:
- Michael Nitschinger
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description MutationState
add(Document... documents)
Add one or moreDocuments
to thisMutationState
.MutationState
add(MutationState mutationState)
Adds all the internal state from the givenMutationState
onto the called one.MutationState
add(DocumentFragment... documentFragments)
Add one or moreDocumentFragments
to thisMutationState
.boolean
equals(Object o)
JsonObject
export()
Exports theMutationState
into 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.JsonObject
exportForFts()
Exports theMutationState
into a format recognized by the FTS search engine.static MutationState
from(Document... documents)
Create aMutationState
from one or moreDocuments
.static MutationState
from(JsonObject source)
Create aMutationState
from the serialized state.static MutationState
from(DocumentFragment... documentFragments)
Create aMutationState
from one or moreDocumentFragments
.static MutationState
from(String source)
Create aMutationState
from the serialized state.int
hashCode()
Iterator<MutationToken>
iterator()
String
toString()
-
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(Document... documents)
Create aMutationState
from one or moreDocuments
.- Parameters:
documents
- the documents where the tokens are extracted from.- Returns:
- the initialized
MutationState
.
-
from
public static MutationState from(DocumentFragment... documentFragments)
Create aMutationState
from one or moreDocumentFragments
.- Parameters:
documentFragments
- the document fragments where the tokens are extracted from.- Returns:
- the initialized
MutationState
.
-
add
public MutationState add(Document... documents)
Add one or moreDocuments
to thisMutationState
.- Parameters:
documents
- the documents where the tokens are extracted from.- Returns:
- the modified
MutationState
.
-
add
public MutationState add(DocumentFragment... documentFragments)
Add one or moreDocumentFragments
to thisMutationState
.- Parameters:
documentFragments
- the fragments where the tokens are extracted from.- Returns:
- the modified
MutationState
.
-
add
public MutationState add(MutationState mutationState)
Adds all the internal state from the givenMutationState
onto 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:
iterator
in interfaceIterable<MutationToken>
-
export
public JsonObject export()
Exports theMutationState
into 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
.
-
exportForFts
public JsonObject exportForFts()
Exports theMutationState
into a format recognized by the FTS search engine.- Returns:
- the exported
JsonObject
for one FTS index.
-
from
public static MutationState from(String source)
Create aMutationState
from the serialized state.- Parameters:
source
- the source state, serialized.- Returns:
- the created
MutationState
.
-
from
public static MutationState from(JsonObject source)
Create aMutationState
from the serialized state.- Parameters:
source
- the source state, serialized.- Returns:
- the created
MutationState
.
-
-