org.refcodes.observer.ActionEvent 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 java.util.Observable;
import java.util.Observer;

/**
 * An {@link ActionEvent} is published by an {@link Observable} and is consumed
 * by zero to many {@link Observer} instances. The {@link ActionEvent} object
 * describes what the {@link Observable} is publishing.
 * 
 * An {@link ActionEvent} provides a source being the origin of the
 * {@link ActionEvent}.
 * 
 * @param  The type of the action stored in the event.
 * @param  The type of the source in question.
 */
public interface ActionEvent extends Event {

	/**
	 * Returns the Action associated to the given {@link ActionEvent}.
	 * 
	 * @param aAction The action which the {@link ActionEvent} represents.
	 * 
	 * @return The action which the {@link ActionEvent} represents.
	 */
	A getAction();

}