Package com.marklogic.client.document

Enum DocumentMetadataPatchBuilder.Cardinality

java.lang.Object

java.lang.Enum<DocumentMetadataPatchBuilder.Cardinality>

com.marklogic.client.document.DocumentMetadataPatchBuilder.Cardinality

Enclosing interface:

DocumentMetadataPatchBuilder

public static enum DocumentMetadataPatchBuilder.Cardinality
extends java.lang.Enum<DocumentMetadataPatchBuilder.Cardinality>

The Cardinality enumeration indicates the number of times that a path can match without error (which defaults to ZERO_OR_MORE, meaning any number of matches).

Enum Constant Summary

Enum Constants

Enum Constant	Description
ONE	Requires exactly one match.
ONE_OR_MORE	Requires at least one match.
ZERO_OR_MORE	Allows any number of matches.
ZERO_OR_ONE	Allows at most one match.

Method Summary

Modifier and Type	Method	Description
java.lang.String	abbreviate()	Returns the standard abbreviation for the cardinality value.
static DocumentMetadataPatchBuilder.Cardinality	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static DocumentMetadataPatchBuilder.Cardinality[]	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

ZERO_OR_ONE

public static final DocumentMetadataPatchBuilder.Cardinality ZERO_OR_ONE

Allows at most one match.

ONE

public static final DocumentMetadataPatchBuilder.Cardinality ONE

Requires exactly one match.

ZERO_OR_MORE

public static final DocumentMetadataPatchBuilder.Cardinality ZERO_OR_MORE

Allows any number of matches.

ONE_OR_MORE

public static final DocumentMetadataPatchBuilder.Cardinality ONE_OR_MORE

Requires at least one match.

Method Detail

values

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

Returns:

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

valueOf

public static DocumentMetadataPatchBuilder.Cardinality 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

abbreviate

public java.lang.String abbreviate()

Returns the standard abbreviation for the cardinality value.

Returns:

the abbreviation