org.refcodes.observer.EventMatcher Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of refcodes-observer Show documentation

Artifact for event handling purposes according to the observer (observable) pattern.

There is a newer version: 1.1.1

// /////////////////////////////////////////////////////////////////////////////
// REFCODES.ORG
// =============================================================================
// This code is copyright (c) by Siegfried Steiner, Munich, Germany and licensed
// under the following (see "http://en.wikipedia.org/wiki/Multi-licensing")
// licenses:
// =============================================================================
// GNU General Public License, v3.0 ("http://www.gnu.org/licenses/gpl-3.0.html")
// together with the GPL linking exception applied; as being applied by the GNU
// Classpath ("http://www.gnu.org/software/classpath/license.html")
// =============================================================================
// Apache License, v2.0 ("http://www.apache.org/licenses/LICENSE-2.0")
// =============================================================================
// Please contact the copyright holding author(s) of the software artifacts in
// question for licensing issues not being covered by the above listed licenses,
// also regarding commercial licensing models or regarding the compatibility
// with other open source licenses.
// /////////////////////////////////////////////////////////////////////////////

package org.refcodes.observer;

import org.refcodes.matcher.Matcher;

/**
 * This interface typifies the {@link Matcher} interface for the usage with
 * {@link ActionEvent} instances. An {@link EventMatcher} most commonly uses the
 * {@link EventMetaData} (as defined with the {@link MetaDataEvent}) in order to
 * determine whether an {@link ActionEvent} matches {@link EventMetaData} properties
 * or not.
 *
 * @param  The matchee type
 */
public interface EventMatcher> extends Matcher {

	/**
	 * Tests whether the given {@link ActionEvent} is matching the {@link Matcher}'s
	 * criteria.
	 * 
	 * @param aEvent The {@link ActionEvent} used for testing its matchability.
	 * 
	 * @return True in case the {@link ActionEvent} matches the {@link Matcher}'s
	 *         criteria, else false.
	 */
	@Override
	boolean isMatching( E aEvent );
}