com.marklogic.client.document

Enum DocumentWriteOperation.OperationType

java.lang.Object

java.lang.Enum<DocumentWriteOperation.OperationType>

com.marklogic.client.document.DocumentWriteOperation.OperationType

All Implemented Interfaces:

Serializable, Comparable<DocumentWriteOperation.OperationType>

Enclosing interface:

DocumentWriteOperation

public static enum DocumentWriteOperation.OperationType
extends Enum<DocumentWriteOperation.OperationType>

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISABLE_METADATA_DEFAULT This write operation (REST API mime part) clears the defaults for the rest of the request.
DOCUMENT_WRITE This write operation (REST API mime part) creates or overwrites one document and/or document metadata.
METADATA_DEFAULT This write operation (REST API mime part) sets the defaults for the rest of the request.

Method Summary

Methods

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

METADATA_DEFAULT

public static final DocumentWriteOperation.OperationType METADATA_DEFAULT

This write operation (REST API mime part) sets the defaults for the rest of the request.

See Also:

REST API Guide -> Constructing a Metadata Part

DISABLE_METADATA_DEFAULT

public static final DocumentWriteOperation.OperationType DISABLE_METADATA_DEFAULT

This write operation (REST API mime part) clears the defaults for the rest of the request. While this removes defaults set previously on the request, this does not completely restore server-side defaults. For more information see the REST API Guide -> Example: Reverting to System Default Metadata

DOCUMENT_WRITE

public static final DocumentWriteOperation.OperationType DOCUMENT_WRITE

This write operation (REST API mime part) creates or overwrites one document and/or document metadata.

See Also:

REST API Guide -> Constructing a Content Part, REST API Guide -> Constructing a Metadata Part, REST API Guide -> Understanding When Metadata is Preserved or Replaced

Method Detail

values

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

Returns:

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

valueOf

public static DocumentWriteOperation.OperationType 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