com.marklogic.client.io

Enum DocumentMetadataHandle.Capability

java.lang.Object

java.lang.Enum<DocumentMetadataHandle.Capability>

com.marklogic.client.io.DocumentMetadataHandle.Capability

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DocumentMetadataHandle.Capability>

Enclosing class:

DocumentMetadataHandle

public static enum DocumentMetadataHandle.Capability
extends java.lang.Enum<DocumentMetadataHandle.Capability>

A document operation restricted to users with a role.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXECUTE Capability to execute the document.
INSERT Capability to create but not modify the document.
NODE_UPDATE Capability to update nodes within the document or properties of the document.
READ Capability to read the document.
UPDATE Capability to create or modify the document.

Method Summary

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

EXECUTE

public static final DocumentMetadataHandle.Capability EXECUTE

Capability to execute the document.

INSERT

public static final DocumentMetadataHandle.Capability INSERT

Capability to create but not modify the document.

READ

public static final DocumentMetadataHandle.Capability READ

Capability to read the document.

UPDATE

public static final DocumentMetadataHandle.Capability UPDATE

Capability to create or modify the document.

NODE_UPDATE

public static final DocumentMetadataHandle.Capability NODE_UPDATE

Capability to update nodes within the document or properties of the document.

Method Detail

values

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

Returns:

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

valueOf

public static DocumentMetadataHandle.Capability 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<DocumentMetadataHandle.Capability>

getValueOf

public static final DocumentMetadataHandle.Capability getValueOf(java.lang.String name)