org.xwiki.observation.event

Interface Event

All Known Subinterfaces:

BeginEvent, BeginFoldEvent, CancelableEvent, EndEvent, EndFoldEvent, FilterableEvent

All Known Implementing Classes:

AbstractCancelableEvent, AbstractFilterableEvent, ActionExecutionEvent, AllEvent, ApplicationStartedEvent, ApplicationStoppedEvent

public interface Event

All Event types must implement this interface.

Version:

$Id: 25fca8d31c8f10e4ba76edee766742e4c52ac310 $

Method Summary

Methods

Modifier and Type	Method and Description
boolean	matches(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.

Method Detail

matches

boolean matches(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.

Parameters:

otherEvent - the occuring event matched against the current object

Returns:

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