org.spongepowered.api.data

Enum DataTransactionResult.Type

java.lang.Object

java.lang.Enum<DataTransactionResult.Type>

org.spongepowered.api.data.DataTransactionResult.Type

All Implemented Interfaces:

Serializable, Comparable<DataTransactionResult.Type>

Enclosing class:

DataTransactionResult

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

The type of transaction result.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANCELLED An operation was cancelled by a third party (eg.
ERROR The DataManipulator operation failed because an unexpected condition occurred.
FAILURE The DataManipulator operation failed for an expected reason (such as the DataManipulator 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 DataManipulator couldn't handle or didn't expect.

Method Summary

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

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 DataManipulator couldn't handle or didn't expect. The state of the DataManipulator is undefined.

SUCCESS

public static final DataTransactionResult.Type SUCCESS

The item data operation succeeded.

FAILURE

public static final DataTransactionResult.Type FAILURE

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

ERROR

public static final DataTransactionResult.Type ERROR

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

CANCELLED

public static final DataTransactionResult.Type CANCELLED

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

Method Detail

values

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

Returns:

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

valueOf

public static DataTransactionResult.Type 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