Module org.refcodes.serial

Package org.refcodes.serial

Class LoopbackPortHub

java.lang.Object

org.refcodes.serial.LoopbackPortHub

All Implemented Interfaces:

PortHub<LoopbackPort,PortMetrics>

Direct Known Subclasses:

CrossoverLoopbackPortHub

public class LoopbackPortHub
extends Object
implements PortHub<LoopbackPort,PortMetrics>

The LoopbackPortHub is a plain implementation of a PortHub serving an infinite number of LoopbackPort instances: When calling toPort(String) and the such port is unknown, then it is created (and from then on known).

Field Summary

Fields

Modifier and Type	Field	Description
protected Set<LoopbackPort>	_ports

Constructor Summary

Constructors

Constructor	Description
LoopbackPortHub()	Constructs an empty LoopbackPortHub.
LoopbackPortHub(String... aPorts)	Constructs the LoopbackPortHub with the given ports (e.g. ports with the given port aliases).

Method Summary

Modifier and Type	Method	Description
LoopbackPort[]	ports()	Lists the available ports of the system.
LoopbackPort	toPort(String aAlias)	Returns the Port identified by the given alias.
LoopbackPort	toPort(String aAlias, PortMetrics aPortMetrics)	Returns the Port identified by the given alias.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.refcodes.serial.PortHub

ports

Field Details

_ports

protected Set<LoopbackPort> _ports

Constructor Details

LoopbackPortHub

public LoopbackPortHub()

Constructs an empty LoopbackPortHub. Add ports by calling toPort(String).

LoopbackPortHub

public LoopbackPortHub(String... aPorts)

Constructs the LoopbackPortHub with the given ports (e.g. ports with the given port aliases).

Parameters:

aPorts - The aliases for the ports to be contained within this PortHub.

Method Details

ports

public LoopbackPort[] ports()
                     throws IOException

Lists the available ports of the system.

Specified by:

ports in interface PortHub<LoopbackPort,PortMetrics>

Returns:

An array of available Port instances, if there are no ports than an empty array (size 0) is returned.

Throws:

IOException - Thrown in case accessing the list of Port instances failed due to I/O problems.

toPort

public LoopbackPort toPort(String aAlias)
                    throws IOException

Returns the Port identified by the given alias.

Specified by:

toPort in interface PortHub<LoopbackPort,PortMetrics>

Parameters:

aAlias - The alias identifying the given Port.

Returns:

The given Port.

Throws:

IOException - Thrown in case accessing the list of Port instances failed due to I/O problems.

toPort

public LoopbackPort toPort(String aAlias,
 PortMetrics aPortMetrics)
                    throws IOException

Returns the Port identified by the given alias.

Specified by:

toPort in interface PortHub<LoopbackPort,PortMetrics>

Parameters:

aAlias - The alias identifying the given Port.

aPortMetrics - The PortMetrics to use when opening the port without providing any specific arguments.

Returns:

The given Port.

Throws:

IOException - Thrown in case accessing the list of Port instances failed due to I/O problems.