org.refcodes.component.ext.observer.AbstractLifecycleStatusEvent 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")
// 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/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.component.LifecycleStatus;
import org.refcodes.mixin.EventMetaData;
import org.refcodes.observer.AbstractMetaDataActionEvent;

/**
 * Abstract implementation of the base {@link GenericLifecycleStatusEvent}.
 * 
 * @param  The type of the action stored in the event.
 * @param  The type of the EventMetaData
 * @param  The type of the source in question.
 */
public abstract class AbstractLifecycleStatusEvent extends AbstractMetaDataActionEvent implements GenericLifecycleStatusEvent {

	// /////////////////////////////////////////////////////////////////////////
	// VARIABLES:
	// /////////////////////////////////////////////////////////////////////////

	protected LifecycleStatus _lifecycleStatus;

	// /////////////////////////////////////////////////////////////////////////
	// CONSTRUCTORS:
	// /////////////////////////////////////////////////////////////////////////

	/**
	 * Instantiates a new abstract life cycle status event.
	 *
	 * @param aLifecycleStatus The lifecycle status.
	 * @param aEventMetaData the event Meta-Data
	 * @param aSource The according source (origin).
	 */
	public AbstractLifecycleStatusEvent( LifecycleStatus aLifecycleStatus, META aEventMetaData, SRC aSource ) {
		super( aEventMetaData, aSource );
		_lifecycleStatus = aLifecycleStatus;
	}

	/**
	 * Instantiates a new abstract life cycle status event.
	 * 
	 * @param aAction The action to be set for this event.
	 * @param aLifecycleStatus The lifecycle status.
	 * @param aEventMetaData the event Meta-Data
	 * @param aSource The according source (origin).
	 */
	public AbstractLifecycleStatusEvent( A aAction, LifecycleStatus aLifecycleStatus, META aEventMetaData, SRC aSource ) {
		super( aAction, aEventMetaData, aSource );
		_lifecycleStatus = aLifecycleStatus;
	}

	/**
	 * Instantiates a new abstract life cycle status event.
	 *
	 * @param aLifecycleStatus The lifecycle status.
	 * @param aSource The according source (origin).
	 */
	public AbstractLifecycleStatusEvent( LifecycleStatus aLifecycleStatus, SRC aSource ) {
		super( aSource );
		_lifecycleStatus = aLifecycleStatus;
	}

	/**
	 * Instantiates a new abstract life cycle status event.
	 * 
	 * @param aAction The action to be set for this event.
	 * @param aLifecycleStatus The lifecycle status.
	 * @param aSource The according source (origin).
	 */
	public AbstractLifecycleStatusEvent( A aAction, LifecycleStatus aLifecycleStatus, SRC aSource ) {
		super( aAction, aSource );
		_lifecycleStatus = aLifecycleStatus;
	}

	// /////////////////////////////////////////////////////////////////////////
	// METHODS:
	// /////////////////////////////////////////////////////////////////////////

	/**
	 * {@inheritDoc}
	 */
	@Override
	public LifecycleStatus getLifecycleStatus() {
		return _lifecycleStatus;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public String toString() {
		return getClass().getSimpleName() + " [lifecycleStatus=" + _lifecycleStatus + ", eventMetaData=" + _eventMetaData + ", action=" + _action + "]";
	}

}