Module org.refcodes.component

Package org.refcodes.component

Class LinkAutomatonImpl

java.lang.Object

org.refcodes.component.LinkAutomatonImpl

All Implemented Interfaces:

Closable, Closable.CloseAutomaton, ClosedAccessor, ConnectionStatusAccessor, LinkComponent, LinkComponent.LinkAutomaton, Openable, Openable.OpenAutomaton, OpenedAccessor

public class LinkAutomatonImpl
extends Object
implements LinkComponent.LinkAutomaton

This class implements a LifecycleComponent.LifecycleAutomaton.

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.ConnectionStatusAccessor

ConnectionStatusAccessor.ConnectionStatusMutator, ConnectionStatusAccessor.ConnectionStatusProperty

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

LinkComponent.LinkAutomaton, LinkComponent.LinkComponentBuilder<B extends LinkComponent.LinkComponentBuilder<B>>

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

Openable.OpenAutomaton, Openable.OpenBuilder<B extends Openable.OpenBuilder<B>>

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

OpenedAccessor.OpenedMutator, OpenedAccessor.OpenedProperty

Field Summary

Fields

Modifier and Type	Field	Description
protected LinkComponent	_connectionComponent

Constructor Summary

Constructors

Constructor	Description
LinkAutomatonImpl()	Empty constructor, such LifecycleComponent.LifecycleAutomaton cannot do much more than decline the various LifecycleStatus states for you.
LinkAutomatonImpl(LinkComponent aConnectionComponent)	This constructor uses a LifecycleStatus for wrapping it inside the LinkAutomatonImpl, making sure of obeying and guarding the correct LifecycleStatus's order of LifecycleStatus states for you.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the component's connection(s).
ConnectionStatus	getConnectionStatus()	Retrieves the ConnectionStatus property from the property.
boolean	isClosable()	Determines whether the component's connection(s) may get closed.
boolean	isClosed()	Retrieves the is-closed status.
boolean	isOpenable()	Determines whether the component's connection(s) may get opened.
boolean	isOpened()	Retrieves the is-opened property from the opened property.
void	open()	Open the component's connection(s).

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

Methods inherited from interface org.refcodes.component.Openable

openUnchecked

Field Details

_connectionComponent

protected LinkComponent _connectionComponent

Constructor Details

LinkAutomatonImpl

public LinkAutomatonImpl()

Empty constructor, such LifecycleComponent.LifecycleAutomaton cannot do much more than decline the various LifecycleStatus states for you.

LinkAutomatonImpl

public LinkAutomatonImpl(LinkComponent aConnectionComponent)

This constructor uses a LifecycleStatus for wrapping it inside the LinkAutomatonImpl, making sure of obeying and guarding the correct LifecycleStatus's order of LifecycleStatus states for you.

Parameters:

aConnectionComponent - The component to be guarded regarding the correct declination of the LifecycleStatus states.

Method Details

getConnectionStatus

public ConnectionStatus getConnectionStatus()

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

Specified by:

getConnectionStatus in interface ConnectionStatusAccessor

Returns:

Returns the ConnectionStatus property stored by the property.

isOpenable

public boolean isOpenable()

Determines whether the component's connection(s) may get opened.

Specified by:

isOpenable in interface Openable.OpenAutomaton

Returns:

True if Openable.open() is possible.

open

public void open()
          throws IOException

Open the component's connection(s).

Specified by:

open in interface Openable

Throws:

IOException - Thrown in case opening or accessing an open line (connection, junction, link) caused problems.

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 of Openable.open() or ConnectionOpenable.open(Object).

Specified by:

isOpened in interface ConnectionStatusAccessor

Specified by:

isOpened in interface OpenedAccessor

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 interface Closable.CloseAutomaton

Returns:

True if Closable.close() is possible.

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 of Closable.close().

Specified by:

isClosed in interface ClosedAccessor

Returns:

True in case of being closed.

close

public void close()
           throws IOException

Closes the component's connection(s). Throws a IOException 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 interface Closable

Throws:

IOException - thrown in case closing failed.