|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.util.EventObject org.apache.wiki.event.WikiEvent org.apache.wiki.event.WikiEngineEvent
public class WikiEngineEvent
WikiEngineEvent indicates a change in the state of the WikiEngine.
WikiEvent
,
Serialized FormField Summary | |
---|---|
static int |
INITIALIZED
Indicates a WikiEngine initialized event, fired after the wiki service is fully available. |
static int |
INITIALIZING
Indicates a WikiEngine initialization event, fired as the wiki service is being initialized (in progress). |
static int |
SHUTDOWN
Indicates a WikiEngine closing event, fired as a signal that the wiki service is shutting down. |
static int |
STOPPED
Indicates a WikiEngine stopped event, fired after halting the wiki service. |
Fields inherited from class org.apache.wiki.event.WikiEvent |
---|
ERROR, UNDEFINED |
Fields inherited from class java.util.EventObject |
---|
source |
Constructor Summary | |
---|---|
WikiEngineEvent(Object eventSource,
int type)
Constructs an instance of this event. |
Method Summary | |
---|---|
String |
eventName()
Returns a textual representation of the event type. |
WikiEngine |
getEngine()
Returns the WikiEngine that spawned this event. |
String |
getTypeDescription()
Returns a human-readable description of the event type. |
WikiEngine |
getWikiEngine()
Deprecated. use getEngine() instead. |
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. |
Methods inherited from class org.apache.wiki.event.WikiEvent |
---|
getSrc, getType, getWhen, toString |
Methods inherited from class java.util.EventObject |
---|
getSource |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int INITIALIZING
public static final int INITIALIZED
public static final int SHUTDOWN
public static final int STOPPED
Constructor Detail |
---|
public WikiEngineEvent(Object eventSource, int type)
eventSource
- the Object that is the source of the event,
which must be the WikiEngine. If it is not, this
method thows a ClassCastExceptiontype
- the event typeMethod Detail |
---|
protected void setType(int type)
setType
in class WikiEvent
type
- the type of this WikiEngineEvent.public WikiEngine getEngine()
public WikiEngine getWikiEngine()
getEngine()
instead.
public static boolean isValidType(int type)
true
if the int value is a WikiPageEvent type.
type
- the event type
public final String eventName()
eventName
in class WikiEvent
public final String getTypeDescription()
getTypeDescription
in class WikiEvent
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |