Class AllEvent

java.lang.Object
org.xwiki.observation.event.AllEvent
All Implemented Interfaces:
Event

public final class AllEvent extends Object implements Event
Special event matcher used by a listener which need to listened to all possible events.
Version:
$Id: 70aa5bda4d20070f73ec88c97493510b353ebbf1 $
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Event
    Unique instance of the event matcher.
  • Method Summary

    Modifier and Type
    Method
    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.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • ALLEVENT

      public static final Event ALLEVENT
      Unique instance of the event matcher.
  • Method Details

    • matches

      public boolean matches(Object otherEvent)
      Description copied from interface: Event
      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.