| java.lang.Object java.util.EventObject com.ecyrd.jspwiki.event.WikiEvent
All known Subclasses: com.ecyrd.jspwiki.event.WorkflowEvent, com.ecyrd.jspwiki.event.WikiEngineEvent, com.ecyrd.jspwiki.event.WikiPageEvent, com.ecyrd.jspwiki.event.WikiSecurityEvent,
WikiEvent | abstract public class WikiEvent extends EventObject (Code) | | Abstract parent class for wiki events.
author: Murray Altheim author: Andrew Jaquith since: 2.3.79 |
Field Summary | |
final public static int | ERROR Indicates a exception or error state. | final public static int | UNDEFINED Indicates an undefined state. |
Constructor Summary | |
public | WikiEvent(Object src, int type) Constructs an instance of this event. |
Method Summary | |
public String | eventName() Returns a textual representation of an event type. | public int | getType() Returns the type of this event.
the type of this WikiEvent. | public String | getTypeDescription() Returns a String (human-readable) description of an event type. | public long | getWhen() Returns the timestamp of when this WikiEvent occurred. | public static boolean | isValidType(int type) Returns true if the int value is a valid WikiEvent type.
Because the WikiEvent class does not itself any event types,
this method returns true if the event type is anything except
WikiEvent.ERROR or
WikiEvent.UNDEFINED . | protected void | setType(int type) Sets the type of this event. | public String | toString() Prints a String (human-readable) representation of this object. |
ERROR | final public static int ERROR(Code) | | Indicates a exception or error state.
|
UNDEFINED | final public static int UNDEFINED(Code) | | Indicates an undefined state.
|
WikiEvent | public WikiEvent(Object src, int type)(Code) | | Constructs an instance of this event.
Parameters: src - the Object that is the source of the event. Parameters: type - the event type. |
eventName | public String eventName()(Code) | | Returns a textual representation of an event type.
the String representation |
getTypeDescription | public String getTypeDescription()(Code) | | Returns a String (human-readable) description of an event type.
This should be subclassed as necessary.
the String description |
getWhen | public long getWhen()(Code) | | Returns the timestamp of when this WikiEvent occurred.
this event's timestamp since: 2.4.74 |
isValidType | public static boolean isValidType(int type)(Code) | | Returns true if the int value is a valid WikiEvent type.
Because the WikiEvent class does not itself any event types,
this method returns true if the event type is anything except
WikiEvent.ERROR or
WikiEvent.UNDEFINED . This method is meant to
be subclassed as appropriate.
|
setType | protected void setType(int type)(Code) | | Sets the type of this event. Validation of acceptable
type values is the responsibility of each subclass.
Parameters: type - the type of this WikiEvent. |
toString | public String toString()(Code) | | Prints a String (human-readable) representation of this object.
This should be subclassed as necessary.
See Also: java.lang.Object.toString the String representation |
|
|