org.refcodes.component.DeviceComponent Maven / Gradle / Ivy
Show all versions of refcodes-component Show documentation
// /////////////////////////////////////////////////////////////////////////////
// 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;
import org.refcodes.component.DeviceComponentHandle.DeviceAutomatonHandle;
import org.refcodes.controlflow.ExceptionWatchdog;
import org.refcodes.exception.Exceptional;
/**
* A component implementing the {@link DeviceComponent} interface supports a
* connecting. I.e. such a component may be instructed open or close a
* connection:
*
* "open" - "close"
*
*
* In case a connection is to be provided to the {@link #open()} method, you may
* use the {@link ConnectionComponent} interface with its
* {@link ConnectionComponent#open(Object)} method, which provides an argument
* specifying the connection to be passed to the {@link Component}.
*
* TODO: Think about also extending the {@link Exceptional} interface! This
* would require to implement some composite {@link ExceptionWatchdog} class!
*/
public interface DeviceComponent extends Openable, Closable {
/**
* A system implementing the {@link DeviceAutomaton} interface supports
* managing {@link DeviceComponent} instances and takes care that the
* open/close statuses are invoked in the correct order by throwing
* according exceptions in case the open/close-cycle is invoked in the wrong
* order.
*
* A {@link DeviceAutomaton} may be used to wrap a {@link DeviceComponent}
* by a {@link DeviceAutomatonHandle} for managing {@link DeviceAutomaton}
* instances.
*
* The {@link DeviceComponent} contains the business-logic where as the
* {@link DeviceAutomatonHandle} provides the frame for managing this
* business-logic. The {@link DeviceAutomaton} takes care of the correct
* open/close-cycle applied on a {@link DeviceComponent}.
*/
public interface DeviceAutomaton extends DeviceComponent, OpenAutomaton, CloseAutomaton, ConnectionStatusAccessor {}
}