Package jmri.jmrix

Class ConnectionStatus

java.lang.Object

jmri.jmrix.ConnectionStatus

public class ConnectionStatus
extends Object

Interface for classes that wish to get notification when the connection to the layout changes.

Maintains a single instance, as there is only one set of connections for the running program.

The "system name" referred to here is the human-readable name like "LocoNet 2" which can be obtained from i.e. SystemConnectionMemo.getUserName(). Not clear whether ConnectionConfig.getConnectionName() is correct. It's not intended to be the prefix from i.e. PortAdapter.getSystemPrefix(). Maybe the right thing is to pass in the SystemConnectionMemo?

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONNECTION_DOWN
static final String	CONNECTION_UNKNOWN
static final String	CONNECTION_UP
(package private) PropertyChangeSupport	pcs
(package private) Map<SystemConnectionMemo,PropertyChangeSupport>	pcsMap

Method Summary

Modifier and Type	Method	Description
void	addConnection(SystemConnectionMemo memo)	Add a connection with a given memo to the portStatus set if not yet present in the set.
void	addPropertyChangeListener(PropertyChangeListener l)
void	addPropertyChangeListener(SystemConnectionMemo memo, PropertyChangeListener l)
(package private) static void	clearInstance()
protected void	firePropertyChange(String p, Object old, SystemConnectionMemo memo)
String	getConnectionState(SystemConnectionMemo memo)	Get the status of a communication port with a given name.
static ConnectionStatus	instance()
boolean	isConnectionOk(SystemConnectionMemo memo)	Confirm status of a communication port is not down.
boolean	isSystemOk(String systemName)	Confirm status of a communication port is not down, based on the system name.
void	removePropertyChangeListener(PropertyChangeListener l)
void	removePropertyChangeListener(SystemConnectionMemo memo, PropertyChangeListener l)
void	setConnectionState(SystemConnectionMemo memo, String state)	Set the connection state of a communication port.

Methods inherited from class java.lang.Object

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

Field Details

CONNECTION_UNKNOWN

public static final String CONNECTION_UNKNOWN

See Also:

• Constant Field Values

CONNECTION_UP

public static final String CONNECTION_UP

See Also:

• Constant Field Values

CONNECTION_DOWN

public static final String CONNECTION_DOWN

See Also:

• Constant Field Values

pcs

PropertyChangeSupport pcs

pcsMap

Map<SystemConnectionMemo,PropertyChangeSupport> pcsMap

Method Details

instance

public static ConnectionStatus instance()

clearInstance

static void clearInstance()

addConnection

public void addConnection(@Nonnull
 SystemConnectionMemo memo)

Add a connection with a given memo to the portStatus set if not yet present in the set.

Parameters:

memo - the system memo

setConnectionState

public void setConnectionState(@Nonnull
 SystemConnectionMemo memo,
 @Nonnull
 String state)

Set the connection state of a communication port.

Parameters:

memo - the system memo

state - one of ConnectionStatus.UP, ConnectionStatus.DOWN, or ConnectionStatus.UNKNOWN.

getConnectionState

public String getConnectionState(@Nonnull
 SystemConnectionMemo memo)

Get the status of a communication port with a given name.

Parameters:

memo - the system memo

Returns:

the status

isConnectionOk

public boolean isConnectionOk(@Nonnull
 SystemConnectionMemo memo)

Confirm status of a communication port is not down.

Parameters:

memo - the system memo

Returns:

true if port connection is operational or unknown, false if not

isSystemOk

public boolean isSystemOk(@Nonnull
 String systemName)

Confirm status of a communication port is not down, based on the system name.

Parameters:

systemName - human-readable name for system like "LocoNet 2" which can be obtained from i.e. SystemConnectionMemo.getUserName().

Returns:

true if port connection is operational or unknown, false if not. This includes returning true if the connection is not recognized.

addPropertyChangeListener

public void addPropertyChangeListener(@Nonnull
 PropertyChangeListener l)

addPropertyChangeListener

public void addPropertyChangeListener(@Nonnull
 SystemConnectionMemo memo,
 @Nonnull
 PropertyChangeListener l)

firePropertyChange

protected void firePropertyChange(@Nonnull
 String p,
 Object old,
 @Nonnull
 SystemConnectionMemo memo)

removePropertyChangeListener

public void removePropertyChangeListener(@Nonnull
 PropertyChangeListener l)

removePropertyChangeListener

public void removePropertyChangeListener(@Nonnull
 SystemConnectionMemo memo,
 @Nonnull
 PropertyChangeListener l)