org.refcodes.observer.ObserverDescriptor 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;

/**
 * This {@link ObserverDescriptor} describes the {@link Observer}, i.e. in some
 * cases an {@link Observer} requires an {@link EventMatcher} which determines
 * which {@link ActionEvent} instances to pass to the {@link Observer}. The
 * {@link ObserverDescriptor} is itself an {@link Observer} calling the
 * {@link EventMatcher} to determine whether to delegate the {@link ActionEvent} to
 * contained {@link Observer} or not.
 */
public interface ObserverDescriptor, O extends Observer, EM extends EventMatcher> extends Observer {

	/**
	 * Returns the {@link Observer} associated with the given
	 * {@link EventMatcher}
	 * 
	 * @return The {@link Observer} as it is being managed by the
	 *         {@link ObserverDescriptor}.
	 */
	O getObserver();

	/**
	 * Returns the {@link EventMatcher} associated with the given
	 * {@link Observer}.
	 * 
	 * @return The {@link EventMatcher} as it is being managed by the
	 *         {@link ObserverDescriptor}.
	 */
	EM getEventMatcher();
}