org.xwiki.observation.event
Class ActionExecutionEvent

java.lang.Object
  org.xwiki.observation.event.ActionExecutionEvent

All Implemented Interfaces:

java.io.Serializable, Event

public class ActionExecutionEvent
extends java.lang.Object
implements Event, java.io.Serializable

An event triggered whenever a client request (action) is processed, like /upload/ or /view/. A specific event corresponds to only one action type.

Version:

$Id: ActionExecutionEvent.java 31147 2010-09-16 14:06:34Z tmortagne $

See Also:

Serialized Form

Constructor Summary

ActionExecutionEvent(java.lang.String actionName)
Constructor initializing the action name of the event.

Method Summary

boolean	equals(java.lang.Object object)
java.lang.String	getActionName() Gets the name of the action causing this event.
int	hashCode()
boolean	matches(java.lang.Object otherEvent) Compares two events to see if they match, meaning that a listener that registered to receive notifications like referenceEvent will be notified of any occuring event for which referenceEvent.matches(occuringEvent) will return true.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ActionExecutionEvent

public ActionExecutionEvent(java.lang.String actionName)

Constructor initializing the action name of the event.

Parameters:

actionName - the name of the executed action

Method Detail

getActionName

public java.lang.String getActionName()

Gets the name of the action causing this event.

Returns:

the action causing this event, like upload or login

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(Object)

matches

public boolean matches(java.lang.Object otherEvent)

Compares two events to see if they match, meaning that a listener that registered to receive notifications like referenceEvent will be notified of any occuring event for which referenceEvent.matches(occuringEvent) will return true. The matching algorithm depends on the event implementation. For example for Document events two events match if they implement the same event class and if their EventFilter match. Note that the implementation is left open in order to cater for all the possible ways this Observation component can be used.

Specified by:

matches in interface Event

Parameters:

otherEvent - the occuring event matched against the current object

Returns:

true if the passed event matches this event, false otherwise.

See Also:

Event.matches(Object)