com.couchbase.client.java.document.subdoc

Enum ExtendDirection

java.lang.Object

java.lang.Enum<ExtendDirection>

com.couchbase.client.java.document.subdoc.ExtendDirection

All Implemented Interfaces:

Serializable, Comparable<ExtendDirection>

@InterfaceStability.Experimental
 @InterfaceAudience.Public
public enum ExtendDirection
extends Enum<ExtendDirection>

The direction for a sub-document array extension operation. See Bucket.extendIn(DocumentFragment, ExtendDirection, boolean, PersistTo, ReplicateTo).

Since:

2.2

Author:

Simon Baslé, Michael Nitschinger

Enum Constant Summary

Enum Constants

Enum Constant and Description
BACK Extend the array by placing the value at the back of the array (largest index).
FRONT Extend the array by placing the value at the front of the array (index 0).

Method Summary

Modifier and Type	Method and Description
static ExtendDirection	valueOf(String name) Returns the enum constant of this type with the specified name.
static ExtendDirection[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FRONT

public static final ExtendDirection FRONT

Extend the array by placing the value at the front of the array (index 0).

BACK

public static final ExtendDirection BACK

Extend the array by placing the value at the back of the array (largest index).

Method Detail

values

public static ExtendDirection[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ExtendDirection c : ExtendDirection.values())
    System.out.println(c);

Returns:

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

valueOf

public static ExtendDirection 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