com.marklogic.client.admin

Enum ServerConfigurationManager.UpdatePolicy

java.lang.Object

java.lang.Enum<ServerConfigurationManager.UpdatePolicy>

com.marklogic.client.admin.ServerConfigurationManager.UpdatePolicy

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ServerConfigurationManager.UpdatePolicy>

Enclosing interface:

ServerConfigurationManager

public static enum ServerConfigurationManager.UpdatePolicy
extends java.lang.Enum<ServerConfigurationManager.UpdatePolicy>

Specifies the policy for updating documents in the database.

Enum Constant Summary

Enum Constants

Enum Constant and Description
MERGE_METADATA If a document exists, the supplied metadata is merged with the persisted document metadata.
OVERWRITE_METADATA The document is written without testing whether it exists.
VERSION_OPTIONAL A document can be updated or deleted if its version number is not supplied or if the version number matches.
VERSION_REQUIRED A document can be updated or deleted only if its version number is supplied and matches; a document can be created only if no version number is supplied and the document doesn't exist.

Method Summary

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

VERSION_REQUIRED

public static final ServerConfigurationManager.UpdatePolicy VERSION_REQUIRED

A document can be updated or deleted only if its version number is supplied and matches; a document can be created only if no version number is supplied and the document doesn't exist. This update policy requires optimistic locking.

VERSION_OPTIONAL

public static final ServerConfigurationManager.UpdatePolicy VERSION_OPTIONAL

A document can be updated or deleted if its version number is not supplied or if the version number matches. This update policy provides for optional optimistic locking.

MERGE_METADATA

public static final ServerConfigurationManager.UpdatePolicy MERGE_METADATA

If a document exists, the supplied metadata is merged with the persisted document metadata. This update policy is the default (equivalent to content versions of Policy.NONE).

OVERWRITE_METADATA

public static final ServerConfigurationManager.UpdatePolicy OVERWRITE_METADATA

The document is written without testing whether it exists. Only the supplied metadata is persisted. This update policy is slightly faster than other update policies.

Method Detail

values

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

Returns:

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

valueOf

public static ServerConfigurationManager.UpdatePolicy 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