Package com.couchbase.client.java.kv

Enum StoreSemantics

java.lang.Object

java.lang.Enum<StoreSemantics>

com.couchbase.client.java.kv.StoreSemantics

All Implemented Interfaces:

Serializable, Comparable<StoreSemantics>, java.lang.constant.Constable

public enum StoreSemantics
extends Enum<StoreSemantics>

Describes how the outer document store semantics on subdoc should act.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSERT	Create the document, fail if it exists.
REPLACE	Replace the document, fail if it does not exist.
REVIVE	Convert from a tombstone to a document.
UPSERT	Replace the document or create it if it does not exist.

Method Summary

Modifier and Type	Method	Description
static StoreSemantics	valueOf(String name)	Returns the enum constant of this type with the specified name.
static StoreSemantics[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

REPLACE

public static final StoreSemantics REPLACE

Replace the document, fail if it does not exist. This is the default.

UPSERT

public static final StoreSemantics UPSERT

Replace the document or create it if it does not exist.

INSERT

public static final StoreSemantics INSERT

Create the document, fail if it exists.

REVIVE

@Internal
public static final StoreSemantics REVIVE

Convert from a tombstone to a document.

Method Details

values

public static StoreSemantics[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static StoreSemantics valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null