org.refcodes.component.CeasableHandle Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of refcodes-component Show documentation
Artifact with common component definitions and functionality.
There is a newer version: 3.3.9
package org.refcodes.component;

import org.refcodes.component.Ceasable.CeaseAutomaton;

/**
 * The {@link CeasableHandle} interface defines those methods related to the
 * handle based cease life-cycle.
 * 
 * The handle reference requires the {@link Ceasable} interface to be
 * implemented.
 *
 * @param  The type of the handle.
 */
public interface CeasableHandle {

	/**
	 * Determines whether the handle reference is ceasable by implementing the
	 * {@link Ceasable} interface.
	 * 
	 * @param aHandle The handle to test whether the reference provides the
	 *        according functionality.
	 * 
	 * @return True in case the reference provides the according functionality.
	 * 
	 * @throws UnknownHandleRuntimeException in case the handle is unknown.
	 */
	boolean hasCeasable( H aHandle ) throws UnknownHandleRuntimeException;

	/**
	 * Ceases the component identified by the given handle.
	 * 
	 * @param aHandle The handle identifying the component.
	 * 
	 * @throws CeaseException in case ceasing fails.
	 * 
	 * @throws UnsupportedHandleOperationRuntimeException in case the reference
	 *         of the handle does not support the requested operation.
	 * 
	 * @throws UnknownHandleRuntimeException in case the given handle is
	 *         unknown.
	 * 
	 * @throws IllegaleHandleStateChangeRuntimeException Thrown in case a state
	 *         change is not possible due to the current state the referenced
	 *         component is in.
	 */
	void cease( H aHandle ) throws CeaseException, UnknownHandleRuntimeException, UnsupportedHandleOperationRuntimeException, IllegaleHandleStateChangeRuntimeException;

	/**
	 * The {@link CeaseAutomatonHandle} interface defines those methods related
	 * to the handle based cease life-cycle.
	 * 
	 * The handle reference requires the {@link CeaseAutomaton} interface to be
	 * implemented.
	 * 
	 * @param  The type of the handle.
	 */
	public interface CeaseAutomatonHandle extends CeasableHandle {

		/**
		 * Determines whether the handle reference is ceasable by implementing
		 * the {@link CeaseAutomaton} interface.
		 * 
		 * @param aHandle The handle to test whether the reference provides the
		 *        according functionality.
		 * 
		 * @return True in case the reference provides the according
		 *         functionality.
		 * 
		 * @throws UnknownHandleRuntimeException in case the handle is unknown.
		 */
		boolean hasCeaseAutomaton( H aHandle ) throws UnknownHandleRuntimeException;

		/**
		 * Determines whether the component identified by the given handle may
		 * get ceased.
		 * 
		 * @param aHandle The handle identifying the component.
		 * 
		 * @return True if {@link #cease(Object)} is possible.
		 * 
		 * @throws UnsupportedHandleOperationRuntimeException in case the
		 *         reference of the handle does not support the requested
		 *         operation.
		 * @throws UnknownHandleRuntimeException in case the given handle is
		 *         unknown.
		 */
		boolean isCeasable( H aHandle ) throws UnknownHandleRuntimeException, UnsupportedHandleOperationRuntimeException;

		/**
		 * Determines whether the component identified by the given handle is
		 * ceased.
		 * 
		 * @param aHandle The handle identifying the component.
		 * 
		 * @return True in case of being ceased, else false.
		 * 
		 * @throws UnsupportedHandleOperationRuntimeException in case the
		 *         reference of the handle does not support the requested
		 *         operation.
		 * @throws UnknownHandleRuntimeException in case the given handle is
		 *         unknown.
		 */
		boolean isCeased( H aHandle ) throws UnknownHandleRuntimeException, UnsupportedHandleOperationRuntimeException;
	}
}