jmri.jmrix

Class AbstractPortController

Show UML class diagram

java.lang.Object

jmri.jmrix.AbstractPortController

All Implemented Interfaces:

PortAdapter

Direct Known Subclasses:

AbstractNetworkPortController, AbstractSerialPortController, AbstractStreamPortController, RaspberryPiAdapter, UsbPortAdapter, XBeeIOStream

public abstract class AbstractPortController
extends Object
implements PortAdapter

Provide an abstract base for *PortController classes.

This is complicated by the lack of multiple inheritance. SerialPortAdapter is an Interface, and its implementing classes also inherit from various PortController types. But we want some common behaviors for those, so we put them here.

See Also:

SerialPortAdapter

Method Summary

Modifier and Type	Method and Description
void	configureOption1(String value) Set the first port option.
void	configureOption2(String value) Set the second port option.
void	configureOption3(String value) Set the third port option.
void	configureOption4(String value) Set the fourth port option.
void	dispose() Clean up before removal.
abstract String	getCurrentPortName()
boolean	getDisabled() Return the disabled state of the adapter.
abstract DataInputStream	getInputStream() Get the InputStream from the port.
String	getManufacturer() Get the system manufacturer's name.
String	getOption1Name()
String	getOption2Name()
String	getOption3Name()
String	getOption4Name()
String[]	getOptionChoices(String option) Get a list of the various choices allowed with a given option.
String	getOptionDisplayName(String option)
String[]	getOptions() Get a list of all the options configured against this adapter.
String	getOptionState(String option) Get the string value of a specific option.
abstract DataOutputStream	getOutputStream() Get the outputStream to the port.
SystemConnectionMemo	getSystemConnectionMemo() Get the SystemConnectionMemo associated with this object.
String	getSystemPrefix() Get the system prefix for this adapter.
String	getUserName() Get the user name for this adapter.
boolean	isDirty() Determine if configuration needs to be written to disk.
boolean	isOptionAdvanced(String option)
boolean	isRestartRequired() Determine if application needs to be restarted for configuration changes to be applied.
abstract void	recover()
void	setDisabled(boolean disabled) Set the connection disabled or enabled.
void	setManufacturer(String manufacturer) Set the system manufacturer's name.
void	setOptionState(String option, String value) Set the value of an option.
void	setSystemConnectionMemo(SystemConnectionMemo connectionMemo) Set the SystemConnectionMemo associated with this object.
void	setSystemPrefix(String systemPrefix) Set the system prefix for this adapter.
void	setUserName(String userName) Set the user name for this adapter.
boolean	status() Query the status of this connection.

Methods inherited from class java.lang.Object

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

Methods inherited from interface jmri.jmrix.PortAdapter

configure, connect

Method Detail

getInputStream

public abstract DataInputStream getInputStream()

Get the InputStream from the port.

Specified by:

getInputStream in interface PortAdapter

Returns:

the InputStream from the port

getOutputStream

public abstract DataOutputStream getOutputStream()

Get the outputStream to the port.

Specified by:

getOutputStream in interface PortAdapter

Returns:

the outputStream to the port

dispose

@OverridingMethodsMustInvokeSuper
public void dispose()

Clean up before removal. Overriding methods must call super.dispose() or document why they are not calling the overridden implementation. In most cases, failure to call the overridden implementation will cause user-visible error.

Specified by:

dispose in interface PortAdapter

status

public boolean status()

Query the status of this connection. This is a question of configuration, not transient hardware status.

Specified by:

status in interface PortAdapter

Returns:

true if OK, at least as far as known

getCurrentPortName

public abstract String getCurrentPortName()

Specified by:

getCurrentPortName in interface PortAdapter

configureOption1

public void configureOption1(String value)

Description copied from interface: PortAdapter

Set the first port option. Only to be used after construction, but before the openPort call.

Specified by:

configureOption1 in interface PortAdapter

Parameters:

value - to set the option to

configureOption2

public void configureOption2(String value)

Description copied from interface: PortAdapter

Set the second port option. Only to be used after construction, but before the openPort call.

Specified by:

configureOption2 in interface PortAdapter

Parameters:

value - to set the option to

configureOption3

public void configureOption3(String value)

Description copied from interface: PortAdapter

Set the third port option. Only to be used after construction, but before the openPort call.

Specified by:

configureOption3 in interface PortAdapter

Parameters:

value - to set the option to

configureOption4

public void configureOption4(String value)

Description copied from interface: PortAdapter

Set the fourth port option. Only to be used after construction, but before the openPort call.

Specified by:

configureOption4 in interface PortAdapter

Parameters:

value - to set the option to

getOption1Name

public String getOption1Name()

Specified by:

getOption1Name in interface PortAdapter

getOption2Name

public String getOption2Name()

Specified by:

getOption2Name in interface PortAdapter

getOption3Name

public String getOption3Name()

Specified by:

getOption3Name in interface PortAdapter

getOption4Name

public String getOption4Name()

Specified by:

getOption4Name in interface PortAdapter

getOptions

public String[] getOptions()

Get a list of all the options configured against this adapter.

Specified by:

getOptions in interface PortAdapter

Returns:

Array of option identifier strings

setOptionState

public void setOptionState(String option,
                           String value)

Set the value of an option.

Specified by:

setOptionState in interface PortAdapter

Parameters:

option - the name string of the option

value - the string value to set the option to

getOptionState

public String getOptionState(String option)

Get the string value of a specific option.

Specified by:

getOptionState in interface PortAdapter

Parameters:

option - the name of the option to query

Returns:

the option value

getOptionChoices

public String[] getOptionChoices(String option)

Get a list of the various choices allowed with a given option.

Specified by:

getOptionChoices in interface PortAdapter

Parameters:

option - the name of the option to query

Returns:

list of valid values for the option, null if none are available

getOptionDisplayName

public String getOptionDisplayName(String option)

Specified by:

getOptionDisplayName in interface PortAdapter

isOptionAdvanced

public boolean isOptionAdvanced(String option)

Specified by:

isOptionAdvanced in interface PortAdapter

getManufacturer

public String getManufacturer()

Description copied from interface: PortAdapter

Get the system manufacturer's name.

Specified by:

getManufacturer in interface PortAdapter

Returns:

manufacturer's name

setManufacturer

public void setManufacturer(String manufacturer)

Description copied from interface: PortAdapter

Set the system manufacturer's name.

Specified by:

setManufacturer in interface PortAdapter

Parameters:

manufacturer - the manufacturer's name

getDisabled

public boolean getDisabled()

Description copied from interface: PortAdapter

Return the disabled state of the adapter.

Specified by:

getDisabled in interface PortAdapter

Returns:

true if disabled

setDisabled

public void setDisabled(boolean disabled)

Set the connection disabled or enabled. By default connections are enabled. If the implementing class does not use a SystemConnectionMemo, this method must be overridden. Overriding methods must call super.setDisabled(boolean) to ensure the configuration change state is correctly set.

Specified by:

setDisabled in interface PortAdapter

Parameters:

disabled - true if connection should be disabled

getSystemPrefix

public String getSystemPrefix()

Description copied from interface: PortAdapter

Get the system prefix for this adapter.

Specified by:

getSystemPrefix in interface PortAdapter

Returns:

the system prefix or null

setSystemPrefix

public void setSystemPrefix(String systemPrefix)

Description copied from interface: PortAdapter

Set the system prefix for this adapter.

Specified by:

setSystemPrefix in interface PortAdapter

Parameters:

systemPrefix - the new system prefix

getUserName

public String getUserName()

Description copied from interface: PortAdapter

Get the user name for this adapter.

Specified by:

getUserName in interface PortAdapter

Returns:

the username or null

setUserName

public void setUserName(String userName)

Description copied from interface: PortAdapter

Set the user name for this adapter.

Specified by:

setUserName in interface PortAdapter

Parameters:

userName - the new user name

recover

public abstract void recover()

Specified by:

recover in interface PortAdapter

isDirty

public boolean isDirty()

Description copied from interface: PortAdapter

Determine if configuration needs to be written to disk.

Specified by:

isDirty in interface PortAdapter

Returns:

true if configuration needs to be saved, false otherwise

isRestartRequired

public boolean isRestartRequired()

Description copied from interface: PortAdapter

Determine if application needs to be restarted for configuration changes to be applied.

Specified by:

isRestartRequired in interface PortAdapter

Returns:

true if application needs to restart, false otherwise

getSystemConnectionMemo

public SystemConnectionMemo getSystemConnectionMemo()

Get the SystemConnectionMemo associated with this object.

This method should only be overridden to ensure that a specific subclass of SystemConnectionMemo is returned. The recommended pattern is: public MySystemConnectionMemo getSystemConnectionMemo() { return (MySystemConnectionMemo) super.getSystemConnectionMemo(); }

Specified by:

getSystemConnectionMemo in interface PortAdapter

Returns:

the currently associated SystemConnectionMemo

setSystemConnectionMemo

@OverridingMethodsMustInvokeSuper
public void setSystemConnectionMemo(@Nonnull
                                                                      SystemConnectionMemo connectionMemo)

Set the SystemConnectionMemo associated with this object.

Overriding implementations must call super.setSystemConnectionMemo(memo) at some point to ensure the SystemConnectionMemo gets set.

Specified by:

setSystemConnectionMemo in interface PortAdapter

Parameters:

connectionMemo - the SystemConnectionMemo to associate with this PortController