org.ceryle.wiki.plugin.assertion
Class AssertionEvent

java.lang.Object
  java.util.EventObject
      com.ecyrd.jspwiki.event.WikiEvent
          org.ceryle.wiki.plugin.assertion.AssertionEvent

All Implemented Interfaces:

Serializable

public class AssertionEvent
extends WikiEvent

AssertionEvent indicates an encounter (the parsing of) with an AssertionPlugin.

Since:

2.3.92

Version:

$Id: AssertionEvent.java,v 1.2 2007-06-15 12:10:13 altheim Exp $

Author:

Murray Altheim

See Also:

WikiEvent, Serialized Form

Field Summary

static int

ASSERTION The event type for an AssertionEvent.

Fields inherited from class com.ecyrd.jspwiki.event.WikiEvent

ERROR, UNDEFINED

Fields inherited from class java.util.EventObject

source

Constructor Summary

AssertionEvent(Object source, Assertion assertion)
Constructs an instance of this event.

Method Summary

Assertion	getAssertion() Returns the Assertion associated with this event.
String	getPageName() Returns the Wiki page name associated with this event.
String	getTypeDescription() Returns a human-readable description of this event's type.

Methods inherited from class com.ecyrd.jspwiki.event.WikiEvent

eventName, getType, getWhen, isValidType, setType, 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

ASSERTION

public static final int ASSERTION

The event type for an AssertionEvent.

See Also:

Constant Field Values

Constructor Detail

AssertionEvent

public AssertionEvent(Object source,
                      Assertion assertion)

Constructs an instance of this event.

Parameters:

source - the Object that is the source of the event, usually an AssertionPlugin

assertion - the Assertion object created from the page-based markup

Method Detail

getAssertion

public Assertion getAssertion()

Returns the Assertion associated with this event.

Returns:

the Assertion associated with this AssertionEvent.

getPageName

public String getPageName()

Returns the Wiki page name associated with this event. This is a convenience method.

Returns:

the Wiki page name associated with this AssertionEvent.

getTypeDescription

public String getTypeDescription()

Returns a human-readable description of this event's type.

Overrides:

getTypeDescription in class WikiEvent