com.marklogic.client.document

Enum BinaryDocumentManager.MetadataExtraction

java.lang.Object

java.lang.Enum<BinaryDocumentManager.MetadataExtraction>

com.marklogic.client.document.BinaryDocumentManager.MetadataExtraction

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BinaryDocumentManager.MetadataExtraction>

Enclosing interface:

BinaryDocumentManager

public static enum BinaryDocumentManager.MetadataExtraction
extends java.lang.Enum<BinaryDocumentManager.MetadataExtraction>

The MetadataExtraction enumeration identifies whether properties are extracted from binary documents to metadata properties on the binary document, to a separate XHTML document, or not at all.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOCUMENT Specifies extraction of metadata to a separate companion XHTML document.
NONE Specifies no extraction of metadata.
PROPERTIES Specifies extraction of metadata to the document properties.

Method Summary

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

PROPERTIES

public static final BinaryDocumentManager.MetadataExtraction PROPERTIES

Specifies extraction of metadata to the document properties.

DOCUMENT

public static final BinaryDocumentManager.MetadataExtraction DOCUMENT

Specifies extraction of metadata to a separate companion XHTML document.

NONE

public static final BinaryDocumentManager.MetadataExtraction NONE

Specifies no extraction of metadata.

Method Detail

values

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

Returns:

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

valueOf

public static BinaryDocumentManager.MetadataExtraction 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