com.luciad.controllers

Enum EventResult

java.lang.Object

java.lang.Enum<EventResult>

com.luciad.controllers.EventResult

All Implemented Interfaces:

Serializable, Comparable<EventResult>

public enum EventResult
extends Enum<EventResult>

This enum can be used to signal if an event was consumed or not.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Consumed Used to signal that an event was consumed.
NotConsumed Used to signal that an event was not consumed, and can still be sent to other event consumers.

Method Summary

Modifier and Type	Method and Description
static EventResult	valueOf(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

Consumed

public static final EventResult Consumed

Used to signal that an event was consumed.

NotConsumed

public static final EventResult NotConsumed

Used to signal that an event was not consumed, and can still be sent to other event consumers.

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(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