org.refcodes.component.impls.AbstractConnectableAutomaton 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.
The 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/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.component.impls;

import org.refcodes.component.CloseException;
import org.refcodes.component.ConnectableComponent.ConnectableAutomaton;
import org.refcodes.component.ConnectionStatus;
import org.refcodes.component.OpenException;
import org.refcodes.component.Openable;
import org.refcodes.component.Openable.OpenAutomaton;
import org.refcodes.controlflow.ControlFlowUtility;

/**
 * The {@link AbstractConnectableAutomaton} implements the very basic
 * {@link AbstractConnectableAutomaton} functionality.
 */
public abstract class AbstractConnectableAutomaton implements ConnectableAutomaton {

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

	private ConnectionStatus _connectionStatus = ConnectionStatus.NONE;

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

	@Override
	public boolean isOpened() {
		return _connectionStatus == ConnectionStatus.OPENED;
	}

	@Override
	public boolean isClosable() {
		return _connectionStatus == ConnectionStatus.OPENED;
	}

	@Override
	public void close() throws CloseException {
		ControlFlowUtility.throwIllegalStateException( !isOpened() );
		setConnectionStatus( ConnectionStatus.CLOSED );
	}

	@Override
	public boolean isClosed() {
		return _connectionStatus == ConnectionStatus.CLOSED;
	}

	@Override
	public ConnectionStatus getConnectionStatus() {
		return _connectionStatus;
	}

	// /////////////////////////////////////////////////////////////////////////
	// HOOKS:
	// /////////////////////////////////////////////////////////////////////////

	/**
	 * @see OpenAutomaton#isOpenable()
	 */
	protected boolean isOpenable() {
		return !isOpened();
	}

	/**
	 * @see Openable#open()
	 */
	protected void open() throws OpenException {
		if ( isOpened() ) {
			throw new OpenException( "Unable to open the connection is is is ALREADY OPEN; connection status is " + getConnectionStatus() + "." );
		}
		setConnectionStatus( ConnectionStatus.OPENED );
	}

	/**
	 * Sets the {@link ConnectionStatus} property for the property.
	 * 
	 * @param aConnectionStatus The {@link ConnectionStatus} property to be
	 *        stored by the property.
	 */
	protected void setConnectionStatus( ConnectionStatus aConnectionStatus ) {
		_connectionStatus = aConnectionStatus;
	}
}