com.marklogic.client.document

Enum DocumentPatchBuilder.Position

java.lang.Object

java.lang.Enum<DocumentPatchBuilder.Position>

com.marklogic.client.document.DocumentPatchBuilder.Position

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DocumentPatchBuilder.Position>

Enclosing interface:

DocumentPatchBuilder

public static enum DocumentPatchBuilder.Position
extends java.lang.Enum<DocumentPatchBuilder.Position>

The Position enumeration indicates the location relative to the context for inserting content.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AFTER Indicates that content should be inserted after the context.
BEFORE Indicates that content should be inserted before the context.
LAST_CHILD Indicates that content should be inserted at the end of the child list for the context.

Method Summary

Modifier and Type	Method and Description
java.lang.String	toString()
static DocumentPatchBuilder.Position	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DocumentPatchBuilder.Position[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BEFORE

public static final DocumentPatchBuilder.Position BEFORE

Indicates that content should be inserted before the context.

AFTER

public static final DocumentPatchBuilder.Position AFTER

Indicates that content should be inserted after the context.

LAST_CHILD

public static final DocumentPatchBuilder.Position LAST_CHILD

Indicates that content should be inserted at the end of the child list for the context.

Method Detail

values

public static DocumentPatchBuilder.Position[] 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 (DocumentPatchBuilder.Position c : DocumentPatchBuilder.Position.values())
    System.out.println(c);

Returns:

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

valueOf

public static DocumentPatchBuilder.Position valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<DocumentPatchBuilder.Position>