com.marklogic.client.document

Enum DocumentPatchBuilder.PathLanguage

java.lang.Object

java.lang.Enum<DocumentPatchBuilder.PathLanguage>

com.marklogic.client.document.DocumentPatchBuilder.PathLanguage

All Implemented Interfaces:

Serializable, Comparable<DocumentPatchBuilder.PathLanguage>

Enclosing interface:

DocumentPatchBuilder

public static enum DocumentPatchBuilder.PathLanguage
extends Enum<DocumentPatchBuilder.PathLanguage>

MarkLogic's REST API patch operations support two path languages for JSON, XPATH and JSONPATH. Default for MarkLogic 8 is XPATH, but you can use the backwards-compatible JSONPATH too.

Enum Constant Summary

Enum Constants

Enum Constant and Description
JSONPATH Indicates that the given patch uses the JSONPATH language.
XPATH Indicates that the given patch uses the XPATH language.

Method Summary

Methods

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

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

XPATH

public static final DocumentPatchBuilder.PathLanguage XPATH

Indicates that the given patch uses the XPATH language.

JSONPATH

public static final DocumentPatchBuilder.PathLanguage JSONPATH

Indicates that the given patch uses the JSONPATH language.

Method Detail

values

public static DocumentPatchBuilder.PathLanguage[] 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.PathLanguage c : DocumentPatchBuilder.PathLanguage.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.PathLanguage 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

toString

public String toString()

Overrides:

toString in class Enum<DocumentPatchBuilder.PathLanguage>