Package org.apache.wiki.event
Class WikiEngineEvent
java.lang.Object
java.util.EventObject
org.apache.wiki.event.WikiEvent
org.apache.wiki.event.WikiEngineEvent
- All Implemented Interfaces:
Serializable
public class WikiEngineEvent extends WikiEvent
WikiEngineEvent indicates a change in the state of the Engine.
- Since:
- 2.4.20
- See Also:
WikiEvent
, Serialized Form
-
Field Summary
Fields Modifier and Type Field Description static int
INITIALIZED
Indicates a Engine initialized event, fired after the wiki service is fully available.static int
INITIALIZING
Indicates a Engine initialization event, fired as the wiki service is being initialized (in progress).static int
SHUTDOWN
Indicates a Engine closing event, fired as a signal that the wiki service is shutting down.static int
STOPPED
Indicates a Engine stopped event, fired after halting the wiki service.Fields inherited from class java.util.EventObject
source
-
Constructor Summary
Constructors Constructor Description WikiEngineEvent(Object eventSource, int type)
Constructs an instance of this event. -
Method Summary
Modifier and Type Method Description String
eventName()
Returns a textual representation of the event type.String
getTypeDescription()
Returns a human-readable description of the event type.static boolean
isValidType(int type)
Returnstrue
if the int value is a WikiPageEvent type.protected void
setType(int type)
Sets the type of this event.Methods inherited from class java.util.EventObject
getSource
-
Field Details
-
INITIALIZING
Indicates a Engine initialization event, fired as the wiki service is being initialized (in progress).- See Also:
- Constant Field Values
-
INITIALIZED
Indicates a Engine initialized event, fired after the wiki service is fully available.- See Also:
- Constant Field Values
-
SHUTDOWN
Indicates a Engine closing event, fired as a signal that the wiki service is shutting down.- See Also:
- Constant Field Values
-
STOPPED
Indicates a Engine stopped event, fired after halting the wiki service. A Engine in this state is not expected to provide further services.- See Also:
- Constant Field Values
-
-
Constructor Details
-
WikiEngineEvent
Constructs an instance of this event.- Parameters:
eventSource
- the Object that is the source of the event, which must be the Engine. If it is not, this method thows a ClassCastExceptiontype
- the event type
-
-
Method Details
-
setType
Sets the type of this event. -
isValidType
Returnstrue
if the int value is a WikiPageEvent type.- Parameters:
type
- the event type- Returns:
- the result
-
eventName
Returns a textual representation of the event type. -
getTypeDescription
Returns a human-readable description of the event type.- Overrides:
getTypeDescription
in classWikiEvent
- Returns:
- a String description of the type
-