Module org.refcodes.component

Package org.refcodes.component

Interface ConnectionStatusAccessor

All Superinterfaces:

OpenedAccessor

All Known Subinterfaces:

BidirectionalConnectionComponent.BidirectionalConnectionAutomaton<INPUT,OUTPUT>, ConnectableComponent.ConnectableAutomaton, ConnectionComponent.ConnectionAutomaton<CON>, ConnectionStatusAccessor.ConnectionStatusProperty, LinkComponent.LinkAutomaton

All Known Implementing Classes:

AbstractConnectableAutomaton, AbstractDeviceAutomaton, ConnectionAutomatonImpl, LinkAutomatonImpl

public interface ConnectionStatusAccessor
extends OpenedAccessor

Provides an accessor for a ConnectionStatus property.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ConnectionStatusAccessor.ConnectionStatusMutator	Provides a mutator for a ConnectionStatus property.
static interface	ConnectionStatusAccessor.ConnectionStatusProperty	Provides a ConnectionStatus property.

Nested classes/interfaces inherited from interface org.refcodes.component.OpenedAccessor

OpenedAccessor.OpenedMutator, OpenedAccessor.OpenedProperty

Method Summary

Modifier and Type	Method	Description
ConnectionStatus	getConnectionStatus()	Retrieves the ConnectionStatus property from the property.
default boolean	isOpened()	Determines whether the connection is ought to be open or not.

Method Details

getConnectionStatus

ConnectionStatus getConnectionStatus()

Retrieves the ConnectionStatus property from the property. Determines in which ConnectionStatus status a component is in.

Returns:

Returns the ConnectionStatus property stored by the property.

isOpened

default boolean isOpened()

Determines whether the connection is ought to be open or not.

Specified by:

isOpened in interface OpenedAccessor

Returns:

True in case the connection is open, else the connection is either closed or of a status ConnectionStatus.NONE.