org.refcodes.component.PausableHandle 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.Pausable.PauseAutomaton;

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

	/**
	 * Determines whether the handle reference is pausable by implementing the
	 * {@link Pausable} 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 hasPausable( H aHandle ) throws UnknownHandleRuntimeException;

	/**
	 * Pauses the component identified by the given handle.
	 * 
	 * @param aHandle The handle identifying the component.
	 * 
	 * @throws PauseException in case pausing 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 pause( H aHandle ) throws PauseException, UnknownHandleRuntimeException, UnsupportedHandleOperationRuntimeException, IllegaleHandleStateChangeRuntimeException;

	/**
	 * The {@link PauseAutomatonHandle} interface defines those methods related
	 * to the handle based pause life-cycle.
	 * 
	 * The handle reference requires the {@link PauseAutomaton} interface to be
	 * implemented.
	 * 
	 * @param  The type of the handle.
	 */
	public interface PauseAutomatonHandle extends PausableHandle {

		/**
		 * Determines whether the handle reference is pausable by implementing
		 * the {@link PauseAutomaton} 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 hasPauseAutomaton( H aHandle ) throws UnknownHandleRuntimeException;

		/**
		 * Determines whether the component identified by the given handle may
		 * get paused.
		 * 
		 * @param aHandle The handle identifying the component.
		 * 
		 * @return True if {@link #pause(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 isPausable( H aHandle ) throws UnknownHandleRuntimeException, UnsupportedHandleOperationRuntimeException;

		/**
		 * Determines whether the component identified by the given handle is
		 * paused.
		 * 
		 * @param aHandle The handle identifying the component.
		 * 
		 * @return True in case of being paused, 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 isPaused( H aHandle ) throws UnknownHandleRuntimeException, UnsupportedHandleOperationRuntimeException;
	}
}