org.hypergraphdb.event
Enum HGListener.Result

java.lang.Object
  java.lang.Enum<HGListener.Result>
      org.hypergraphdb.event.HGListener.Result

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<HGListener.Result>

Enclosing interface:

HGListener

public static enum HGListener.Result
extends java.lang.Enum<HGListener.Result>

Enum Constant Summary

cancel
This result indicates that processing should be cancelled.

ok
This result indicates that processing should continue normally.

Method Summary

java.lang.String	toString()
static HGListener.Result	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static HGListener.Result[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ok

public static final HGListener.Result ok

This result indicates that processing should continue normally.

cancel

public static final HGListener.Result cancel

This result indicates that processing should be cancelled. When a listener returns a cancel result, event processing is interrupted and the calling HyperGraph instance is notified. The HyperGraph instance may or may not honor the cancellation depending on the particular event type. This per-event-type behavior is document in each event class.

Method Detail

values

public static final HGListener.Result[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(HGListener.Result c : HGListener.Result.values())
        System.out.println(c);

Returns:

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

valueOf

public static HGListener.Result 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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<HGListener.Result>