org.refcodes.component.ext.observer.GenericLifecycleRequestObserver Maven / Gradle / Ivy

Go to download

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

Artifact for providing event based extended functionality for the refcodes-component artifact.

There is a newer version: 3.3.8

Show newest version

// /////////////////////////////////////////////////////////////////////////////
// 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")
// -----------------------------------------------------------------------------
// Apache License, v2.0 ("http://www.apache.org/licenses/TEXT-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.component.ext.observer;

import org.refcodes.mixin.EventMetaData;

/**
 * The {@link GenericLifecycleRequestObserver} is signaled upon
 * {@link GenericLifecycleRequestEvent} events.
 */
public interface GenericLifecycleRequestObserver, START extends GenericStartEvent, RESUME extends GenericResumeEvent, PAUSE extends GenericPauseEvent, STOP extends GenericStopEvent, DESTROY extends GenericDestroyEvent, META extends EventMetaData, SRC> {

	/**
	 * In case a component is to be initialized, then the
	 * {@link GenericInitializeEvent} event is fired.
	 * 
	 * @param aEvent The according {@link GenericInitializeEvent}.
	 */
	void onInitialize( INIT aEvent );

	/**
	 * In case a component is to be initialized, then the
	 * {@link GenericStartEvent} event is fired.
	 * 
	 * @param aEvent The according {@link GenericStartEvent}.
	 */
	void onStart( START aEvent );

	/**
	 * In case a component is to be initialized, then the
	 * {@link GenericResumeEvent} event is fired.
	 * 
	 * @param aEvent The according {@link GenericResumeEvent}.
	 */
	void onResume( RESUME aEvent );

	/**
	 * In case a component is to be initialized, then the
	 * {@link GenericPauseEvent} event is fired.
	 * 
	 * @param aEvent The according {@link GenericPauseEvent}.
	 */
	void onPause( PAUSE aEvent );

	/**
	 * In case a component is to be initialized, then the
	 * {@link GenericStopEvent} event is fired.
	 * 
	 * @param aEvent The according {@link GenericStopEvent}.
	 */
	void onStop( STOP aEvent );

	/**
	 * In case a component is to be initialized, then the
	 * {@link GenericDestroyEvent} event is fired.
	 * 
	 * @param aEvent The according {@link GenericDestroyEvent}.
	 */
	void onDestroy( DESTROY aEvent );

}