com.textkernel.tx.models.api.indexes

Enum UserDefinedTagsMethod

java.lang.Object

java.lang.Enum<UserDefinedTagsMethod>

com.textkernel.tx.models.api.indexes.UserDefinedTagsMethod

All Implemented Interfaces:

Serializable, Comparable<UserDefinedTagsMethod>

public enum UserDefinedTagsMethod
extends Enum<UserDefinedTagsMethod>

A method to use when updating user-defined tags on a document

Enum Constant Summary

Enum Constants

Enum Constant and Description
Add Adds the specified user-defined tags to a document (in addition to any existing)
Delete Deletes the specified user-defined tags from a document
Overwrite Overwrites any existing user-defined tags with the specified tags

Method Summary

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

Delete

public static final UserDefinedTagsMethod Delete

Deletes the specified user-defined tags from a document

Add

public static final UserDefinedTagsMethod Add

Adds the specified user-defined tags to a document (in addition to any existing)

Overwrite

public static final UserDefinedTagsMethod Overwrite

Overwrites any existing user-defined tags with the specified tags

Method Detail

values

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

Returns:

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

valueOf

public static UserDefinedTagsMethod 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