org.xwiki.observation.event.Event Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xwiki-commons-observation-api Show documentation

XWiki Commons - Observation - API

The newest version!

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.observation.event;

/**
 * All Event types must implement this interface.
 *
 * @version $Id: 25fca8d31c8f10e4ba76edee766742e4c52ac310 $
 */
public 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 {@link org.xwiki.observation.event.filter.EventFilter} match. Note that the implementation is
     * left open in order to cater for all the possible ways this Observation component can be used.
     *
     * @param otherEvent the occuring event matched against the current object
     * @return true if the passed event matches this event, false otherwise.
     */
    boolean matches(Object otherEvent);
}