java.lang.Object
org.refcodes.component.AbstractConnectable
org.refcodes.component.AbstractConnectableAutomaton
- All Implemented Interfaces:
Closable
,Closable.CloseAutomaton
,ClosedAccessor
,ConnectableComponent
,ConnectableComponent.ConnectableAutomaton
,ConnectionStatusAccessor
,OpenedAccessor
- Direct Known Subclasses:
AbstractDeviceAutomaton
public abstract class AbstractConnectableAutomaton
extends AbstractConnectable
implements ConnectableComponent.ConnectableAutomaton
The
AbstractConnectableAutomaton
implements the very basic
AbstractConnectableAutomaton
functionality.-
Nested Class Summary
Nested classes/interfaces inherited from interface org.refcodes.component.Closable
Closable.CloseAutomaton, Closable.CloseBuilder<B extends Closable.CloseBuilder<B>>
Nested classes/interfaces inherited from interface org.refcodes.component.ClosedAccessor
ClosedAccessor.ClosedMutator, ClosedAccessor.ClosedProperty
Nested classes/interfaces inherited from interface org.refcodes.component.ConnectableComponent
ConnectableComponent.ConnectableAutomaton
Nested classes/interfaces inherited from interface org.refcodes.component.ConnectionStatusAccessor
ConnectionStatusAccessor.ConnectionStatusMutator, ConnectionStatusAccessor.ConnectionStatusProperty
Nested classes/interfaces inherited from interface org.refcodes.component.OpenedAccessor
OpenedAccessor.OpenedMutator, OpenedAccessor.OpenedProperty
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Closes the component's connection(s).Retrieves theConnectionStatus
property from the property.boolean
Determines whether the component's connection(s) may get closed.boolean
isClosed()
Retrieves the is-closed status.protected boolean
Checks if is openable.boolean
isOpened()
Retrieves the is-opened property from the opened property.protected void
open()
Open.protected void
setConnectionStatus
(ConnectionStatus aConnectionStatus) Sets theConnectionStatus
property for the property.Methods inherited from class org.refcodes.component.AbstractConnectable
isThrownAsOfAlreadyClosed
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.refcodes.component.Closable
closeIn, closeQuietly, closeUnchecked
-
Constructor Details
-
AbstractConnectableAutomaton
public AbstractConnectableAutomaton()
-
-
Method Details
-
isOpened
public boolean isOpened()Retrieves the is-opened property from the opened property. Determines whether the component's connection is opened. A component's connection is opened after being opened as ofOpenable.open()
orConnectionOpenable.open(Object)
.- Specified by:
isOpened
in interfaceConnectionStatusAccessor
- Specified by:
isOpened
in interfaceOpenedAccessor
- Returns:
- True in case of being opened (returns the is-opened property stored by the opened property).
-
isClosable
public boolean isClosable()Determines whether the component's connection(s) may get closed.- Specified by:
isClosable
in interfaceClosable.CloseAutomaton
- Returns:
- True if
Closable.close()
is possible.
-
close
Closes the component's connection(s). Throws aIOException
as upon close we may have to do things like flushing buffers which can fail (and would otherwise fail unhandled or even worse unnoticed).- Specified by:
close
in interfaceClosable
- Throws:
IOException
- thrown in case closing failed.
-
isClosed
public boolean isClosed()Retrieves the is-closed status. Determines whether the component's connection is closed. A component's connection is closed after being closed as ofClosable.close()
.- Specified by:
isClosed
in interfaceClosedAccessor
- Returns:
- True in case of being closed.
-
getConnectionStatus
Retrieves theConnectionStatus
property from the property. Determines in whichConnectionStatus
status a component is in.- Specified by:
getConnectionStatus
in interfaceConnectionStatusAccessor
- Returns:
- Returns the
ConnectionStatus
property stored by the property.
-
isOpenable
protected boolean isOpenable()Checks if is openable.- Returns:
- true, if is openable
- See Also:
-
open
Open.- Throws:
IOException
- the open exception- See Also:
-
setConnectionStatus
Sets theConnectionStatus
property for the property.- Parameters:
aConnectionStatus
- TheConnectionStatus
property to be stored by the property.
-