|
||||||||||
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
public abstract class WikiEvent
Abstract parent class for wiki events.
Field Summary | |
---|---|
static int |
ERROR
Indicates a exception or error state. |
static int |
UNDEFINED
Indicates an undefined state. |
Fields inherited from class java.util.EventObject |
---|
source |
Constructor Summary | |
---|---|
WikiEvent(Object src,
int type)
Constructs an instance of this event. |
Method Summary | ||
---|---|---|
String |
eventName()
Returns a textual representation of an event type. |
|
|
getSrc()
Convenience method that returns the typed object to which the event applied. |
|
int |
getType()
Returns the type of this event. |
|
String |
getTypeDescription()
Returns a String (human-readable) description of an event type. |
|
long |
getWhen()
Returns the timestamp of when this WikiEvent occurred. |
|
static boolean |
isValidType(int type)
Returns true if the int value is a valid WikiEvent type. |
|
protected void |
setType(int type)
Sets the type of this event. |
|
String |
toString()
Prints a String (human-readable) representation of this object. |
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 ERROR
public static final int UNDEFINED
Constructor Detail |
---|
public WikiEvent(Object src, int type)
src
- the Object that is the source of the event.type
- the event type.Method Detail |
---|
public <T> T getSrc()
public long getWhen()
protected void setType(int type)
type
- the type of this WikiEvent.public int getType()
WikiEvent
).public String getTypeDescription()
public static boolean isValidType(int type)
ERROR
or UNDEFINED
. This method is meant to
be subclassed as appropriate.
type
- The value to test.
public String eventName()
public String toString()
toString
in class EventObject
Object.toString()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |