org.refcodes.observer.EventMetaData 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.mixin.ChannelAccessor;
import org.refcodes.mixin.GroupAccessor;
import org.refcodes.mixin.NameAccessor;
import org.refcodes.mixin.UniversalIdAccessor;

/**
 * The meta data describes the event which a publisher posts via the event bus
 * to an event subscriber's event listener. The meta data is the criteria most
 * commonly used by an event matcher in order to identify an loosely coupled
 * event.
 *
 * @param  THe event publisher's type from whom the event originates from.
 */
public interface EventMetaData extends UniversalIdAccessor, NameAccessor, GroupAccessor, ChannelAccessor {

	/**
	 * The least common denominator in event meta data is the type of the
	 * publisher which gives a hint on the source of the event.
	 * 
	 * @return The type of the publisher who published the event.
	 */
	Class getPublisherType();
}