| com.ecyrd.jspwiki.event.WikiEvent com.ecyrd.jspwiki.event.WikiEngineEvent
Field Summary | |
final public static int | INITIALIZED Indicates a WikiEngine initialized event, fired after the
wiki service is fully available. | final public static int | INITIALIZING Indicates a WikiEngine initialization event, fired as the
wiki service is being initialized (in progress). | final public static int | SHUTDOWN Indicates a WikiEngine closing event, fired as a signal that
the wiki service is shutting down. | final public static int | STOPPED Indicates a WikiEngine stopped event, fired after halting the wiki service.
A WikiEngine in this state is not expected to provide further services. |
Constructor Summary | |
public | WikiEngineEvent(Object eventSource, int type) Constructs an instance of this event.
Parameters: eventSource - the Object that is the source of the event,which must be the WikiEngine. |
Method Summary | |
final public String | eventName() Returns a textual representation of the event type. | public WikiEngine | getEngine() Returns the WikiEngine that spawned this event. | final public String | getTypeDescription() Returns a human-readable description of the event type. | public WikiEngine | getWikiEngine() Returns the WikiEngine that spawned this event. | public static boolean | isValidType(int type) Returns true if the int value is a WikiPageEvent type. | protected void | setType(int type) Sets the type of this event. |
INITIALIZED | final public static int INITIALIZED(Code) | | Indicates a WikiEngine initialized event, fired after the
wiki service is fully available.
|
INITIALIZING | final public static int INITIALIZING(Code) | | Indicates a WikiEngine initialization event, fired as the
wiki service is being initialized (in progress).
|
SHUTDOWN | final public static int SHUTDOWN(Code) | | Indicates a WikiEngine closing event, fired as a signal that
the wiki service is shutting down.
|
STOPPED | final public static int STOPPED(Code) | | Indicates a WikiEngine stopped event, fired after halting the wiki service.
A WikiEngine in this state is not expected to provide further services.
|
WikiEngineEvent | public WikiEngineEvent(Object eventSource, int type)(Code) | | Constructs an instance of this event.
Parameters: eventSource - the Object that is the source of the event,which must be the WikiEngine. If it is not, thismethod thows a ClassCastException Parameters: type - the event type |
eventName | final public String eventName()(Code) | | Returns a textual representation of the event type.
a String representation of the type |
getEngine | public WikiEngine getEngine()(Code) | | Returns the WikiEngine that spawned this event.
the WikiEngine that spawned this event. |
getTypeDescription | final public String getTypeDescription()(Code) | | Returns a human-readable description of the event type.
a String description of the type |
isValidType | public static boolean isValidType(int type)(Code) | | Returns true if the int value is a WikiPageEvent type.
Parameters: type - the event type the result |
setType | protected void setType(int type)(Code) | | Sets the type of this event.
Parameters: type - the type of this WikiEngineEvent. |
|
|