de.ellpeck.rockbottom.api.event

Enum EventResult

java.lang.Object

java.lang.Enum<EventResult>

de.ellpeck.rockbottom.api.event.EventResult

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<EventResult>

public enum EventResult
extends java.lang.Enum<EventResult>

The result of any Event being fired in the IEventHandler, where DEFAULT means that the event was unchanged, MODIFIED means that the data in the event was modified and CANCELLED meaning that the event was cancelled. The first two values have a dynamic usage, but generally speaking, if you change any of the values in the event's class, you should use MODIFIED as the result if not otherwise stated in the description of the event's class.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANCELLED
DEFAULT
MODIFIED

Method Summary

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

DEFAULT

public static final EventResult DEFAULT

MODIFIED

public static final EventResult MODIFIED

CANCELLED

public static final EventResult CANCELLED

Method Detail

values

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

Returns:

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

valueOf

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