Package org.spongepowered.api.data

Enum Class DataTransactionResult.Type

java.lang.Object

java.lang.Enum<DataTransactionResult.Type>

org.spongepowered.api.data.DataTransactionResult.Type

All Implemented Interfaces:

Serializable, Comparable<DataTransactionResult.Type>, Constable

Enclosing class:

DataTransactionResult

public static enum DataTransactionResult.Type
extends Enum<DataTransactionResult.Type>

The type of transaction result.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CANCELLED	An operation was cancelled by a third party (eg.
ERROR	The Value operation failed because an unexpected condition occurred.
FAILURE	The Value operation failed for an expected reason (such as the Value being incompatible with the DataHolder.
SUCCESS	The item data operation succeeded.
UNDEFINED	The actual result of the operation is undefined, this probably indicates that something went wrong with the operation that the Value couldn't handle or didn't expect.

Method Summary

Modifier and Type	Method	Description
static DataTransactionResult.Type	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DataTransactionResult.Type[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNDEFINED

public static final DataTransactionResult.Type UNDEFINED

The actual result of the operation is undefined, this probably indicates that something went wrong with the operation that the Value couldn't handle or didn't expect. The state of the Value is undefined.

SUCCESS

public static final DataTransactionResult.Type SUCCESS

The item data operation succeeded.

FAILURE

public static final DataTransactionResult.Type FAILURE

The Value operation failed for an expected reason (such as the Value being incompatible with the DataHolder. The condition of the Value is unchanged.

ERROR

public static final DataTransactionResult.Type ERROR

The Value operation failed because an unexpected condition occurred. The state of the Value is undefined.

CANCELLED

public static final DataTransactionResult.Type CANCELLED

An operation was cancelled by a third party (eg. a Value event was cancelled). The condition of the Value is unchanged.

Method Details

values

public static DataTransactionResult.Type[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static DataTransactionResult.Type valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null