com.marklogic.client.document

Enum DocumentManager.Metadata

java.lang.Object

java.lang.Enum<DocumentManager.Metadata>

com.marklogic.client.document.DocumentManager.Metadata

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DocumentManager.Metadata>

Enclosing interface:

DocumentManager<R extends AbstractReadHandle,W extends AbstractWriteHandle>

public static enum DocumentManager.Metadata
extends java.lang.Enum<DocumentManager.Metadata>

The Metadata enumeration specifies the categories of metadata read from or written to the database.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL Specifies all document metadata categories.
COLLECTIONS Specifies document collections.
METADATAVALUES Specifies document metadata-values.
PERMISSIONS Specifies document permissions.
PROPERTIES Specifies document properties.
QUALITY Specifies document search quality.

Method Summary

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

ALL

public static final DocumentManager.Metadata ALL

Specifies all document metadata categories.

COLLECTIONS

public static final DocumentManager.Metadata COLLECTIONS

Specifies document collections.

PERMISSIONS

public static final DocumentManager.Metadata PERMISSIONS

Specifies document permissions.

PROPERTIES

public static final DocumentManager.Metadata PROPERTIES

Specifies document properties.

QUALITY

public static final DocumentManager.Metadata QUALITY

Specifies document search quality.

METADATAVALUES

public static final DocumentManager.Metadata METADATAVALUES

Specifies document metadata-values.

Method Detail

values

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

Returns:

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

valueOf

public static DocumentManager.Metadata 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<DocumentManager.Metadata>