uk.co.mullsoft.jean
Class JEANAPI.JEANEvent

java.lang.Object
  extended by uk.co.mullsoft.jean.JEANAPI.JEANEvent
Enclosing class:
JEANAPI

public static class JEANAPI.JEANEvent
extends java.lang.Object

This class represents a JEAN event. The possible events are:

The situations in which they occur should be obvious from the names.


Constructor Summary
protected JEANAPI.JEANEvent(JEANAPI api, long node, java.lang.String name, boolean pre, int eventType, java.lang.Object parameter)
           
 
Method Summary
protected  boolean fitsMask(JEANAPI.JEANEventMask mask)
           
 JEANAPI getAPI()
          Get the api which generated this event.
 int getEventType()
          Getter for property eventType.
 java.lang.String getName()
          Get the name of this event.
 long getNode()
          Get the id of the node on which this event occurred (if appropriate).
 java.lang.Object getParameter()
          Getter for property parameter.
 boolean isPre()
          Check if event object is being created pre or post the actual event occurrence
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

JEANAPI.JEANEvent

protected JEANAPI.JEANEvent(JEANAPI api,
                            long node,
                            java.lang.String name,
                            boolean pre,
                            int eventType,
                            java.lang.Object parameter)
Method Detail

getAPI

public JEANAPI getAPI()
Get the api which generated this event.

Returns:
the api which generated this event.

getNode

public long getNode()
Get the id of the node on which this event occurred (if appropriate).

Returns:
the id of the node on which this event occurred (if appropriate).

getName

public java.lang.String getName()
Get the name of this event.

Returns:
the name of this event.

isPre

public boolean isPre()
Check if event object is being created pre or post the actual event occurrence

Returns:
true if the event object is created before the event occurrs, false otherwise.

getEventType

public int getEventType()
Getter for property eventType.

Returns:
Value of property eventType.

getParameter

public java.lang.Object getParameter()
Getter for property parameter.

Returns:
Value of property parameter.

fitsMask

protected boolean fitsMask(JEANAPI.JEANEventMask mask)

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object