Package com.xpn.xwiki.plugin.tag

Enum TagOperationResult

java.lang.Object

java.lang.Enum<TagOperationResult>

com.xpn.xwiki.plugin.tag.TagOperationResult

All Implemented Interfaces:

Serializable, Comparable<TagOperationResult>

public enum TagOperationResult
extends Enum<TagOperationResult>

The result of a TagPlugin operation.

Version:

$Id: bfda78a7e5d57fc55597ab24ebd385e2c1be6a9c $

Enum Constant Summary

Enum Constants

Enum Constant	Description
FAILED	The operation failed with an exception.
NO_EFFECT	The operation did not change any data.
NOT_ALLOWED	The current user does not have permission to perform the operation.
OK	The operation was successful, and data changes occurred.

Method Summary

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

OK

public static final TagOperationResult OK

The operation was successful, and data changes occurred.

NO_EFFECT

public static final TagOperationResult NO_EFFECT

The operation did not change any data.

NOT_ALLOWED

public static final TagOperationResult NOT_ALLOWED

The current user does not have permission to perform the operation.

FAILED

public static final TagOperationResult FAILED

The operation failed with an exception.

Method Detail

values

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

Returns:

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

valueOf

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