Class SerialLightManager
- java.lang.Object
-
- jmri.beans.PropertyChangeSupport
-
- jmri.beans.VetoableChangeSupport
-
- jmri.managers.AbstractManager<Light>
-
- jmri.managers.AbstractLightManager
-
- jmri.jmrix.powerline.SerialLightManager
-
- All Implemented Interfaces:
java.beans.PropertyChangeListener
,java.beans.VetoableChangeListener
,java.util.EventListener
,PropertyChangeFirer
,PropertyChangeProvider
,SilenceablePropertyChangeProvider
,VetoableChangeFirer
,VetoableChangeProvider
,LightManager
,Manager<Light>
,NameIncrementingManager
,ProvidingManager<Light>
- Direct Known Subclasses:
SpecificLightManager
,SpecificLightManager
,SpecificLightManager
,SpecificLightManager
,SpecificLightManager
public abstract class SerialLightManager extends AbstractLightManager
Implement LightManager for Powerline serial systems.System names are "PLnnn", where P is the user configurable system prefix, nnn is the bit number without padding.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface jmri.Manager
Manager.ManagerDataEvent<E extends NamedBean>, Manager.ManagerDataListener<E extends NamedBean>, Manager.NameValidity
-
-
Field Summary
Fields Modifier and Type Field Description (package private) SerialTrafficController
tc
-
Fields inherited from class jmri.managers.AbstractManager
_beans, _tsys, _tuser, memo, silenceableProperties, silencedProperties
-
Fields inherited from class jmri.beans.VetoableChangeSupport
vetoableChangeSupport
-
Fields inherited from class jmri.beans.PropertyChangeSupport
propertyChangeSupport
-
Fields inherited from interface jmri.Manager
ANALOGIOS, AUDIO, BLOCKBOSS, BLOCKS, CONDITIONALS, CTCDATA, ENTRYEXIT, IDTAGS, LAYOUTBLOCKS, LIGHTS, LOGIXNG_ANALOG_ACTIONS, LOGIXNG_ANALOG_EXPRESSIONS, LOGIXNG_CONDITIONALNGS, LOGIXNG_DIGITAL_ACTIONS, LOGIXNG_DIGITAL_BOOLEAN_ACTIONS, LOGIXNG_DIGITAL_EXPRESSIONS, LOGIXNG_GLOBAL_VARIABLES, LOGIXNG_MODULES, LOGIXNG_STRING_ACTIONS, LOGIXNG_STRING_EXPRESSIONS, LOGIXNG_TABLES, LOGIXNGS, LOGIXS, MEMORIES, METERFRAMES, METERS, OBLOCKS, PANELFILES, REPORTERS, ROUTES, SECTIONS, SENSORGROUPS, SENSORS, SIGNALGROUPS, SIGNALHEADS, SIGNALMASTLOGICS, SIGNALMASTS, STRINGIOS, TIMEBASE, TRANSITS, TURNOUTS, WARRANTS
-
-
Constructor Summary
Constructors Constructor Description SerialLightManager(SerialTrafficController tc)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description boolean
allowMultipleAdditions(java.lang.String systemName)
Determines if it is possible to add a range of NamedBeans in numerical order for a particular system implementation.protected Light
createNewLight(java.lang.String systemName, java.lang.String userName)
Method to create a new Light based on the system name Returns null if the system name is not in a valid format Assumes calling method has checked that a Light with this system name does not already existprotected abstract Light
createNewSpecificLight(java.lang.String systemName, java.lang.String userName)
Create light of a specific type for the interfacejava.lang.String
getEntryToolTip()
Get a manager-specific tool tip for adding an entry to the manager.SerialSystemConnectionMemo
getMemo()
Get the system connection for this manager.boolean
supportsVariableLights(java.lang.String systemName)
Test if system in the given name can support a variable light.java.lang.String
validateSystemNameFormat(java.lang.String name, java.util.Locale locale)
Validate the format of name, returning it unchanged if valid.boolean
validSystemNameConfig(java.lang.String systemName)
Public method to validate system name for configurationManager.NameValidity
validSystemNameFormat(java.lang.String systemName)
Test if parameter is a properly formatted system name.-
Methods inherited from class jmri.managers.AbstractLightManager
activateAllLights, convertSystemNameToAlternate, getBeanTypeHandled, getLight, getNamedBeanClass, getXMLOrder, newLight, provideLight, typeLetter
-
Methods inherited from class jmri.managers.AbstractManager
addDataListener, checkNumeric, createSystemName, deleteBean, deregister, dispose, fireDataListenersAdded, fireDataListenersRemoved, fireVetoableChange, getAutoSystemName, getBySystemName, getBySystemName, getByUserName, getKnownBeanProperties, getNamedBean, getNamedBeanSet, getObjectCount, getOuterBean, getSystemPrefix, handleUserNameUniqueness, makeSystemName, propertyChange, register, registerSelf, registerUserName, removeDataListener, setDataListenerMute, setPropertyChangesSilenced, updateAutoNumber, vetoableChange
-
Methods inherited from class jmri.beans.VetoableChangeSupport
addVetoableChangeListener, addVetoableChangeListener, fireVetoableChange, fireVetoableChange, fireVetoableChange, getVetoableChangeListeners, getVetoableChangeListeners, removeVetoableChangeListener, removeVetoableChangeListener
-
Methods inherited from class jmri.beans.PropertyChangeSupport
addPropertyChangeListener, addPropertyChangeListener, fireIndexedPropertyChange, fireIndexedPropertyChange, fireIndexedPropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface jmri.LightManager
createSystemName, dispose, getBySystemName, getByUserName, provide
-
Methods inherited from interface jmri.Manager
addDataListener, deleteBean, deregister, getBeanTypeHandled, getKnownBeanProperties, getNamedBean, getNamedBeanSet, getObjectCount, getSubSystemNamePrefix, getSystemNamePrefix, getSystemPrefix, isValidSystemNameFormat, makeSystemName, makeSystemName, makeSystemName, register, removeDataListener, setDataListenerMute, validateBadCharsInSystemNameFormat, validateIntegerSystemNameFormat, validateNmraAccessorySystemNameFormat, validateSystemNameFormat, validateSystemNameFormatOnlyNumeric, validateSystemNamePrefix, validateTrimmedMin1NumberSystemNameFormat, validateTrimmedSystemNameFormat, validateUppercaseTrimmedSystemNameFormat
-
Methods inherited from interface jmri.NameIncrementingManager
getNextValidSystemName
-
Methods inherited from interface jmri.beans.PropertyChangeProvider
addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener
-
Methods inherited from interface jmri.beans.SilenceablePropertyChangeProvider
setPropertyChangesSilenced
-
Methods inherited from interface jmri.beans.VetoableChangeProvider
addVetoableChangeListener, addVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, removeVetoableChangeListener, removeVetoableChangeListener
-
-
-
-
Constructor Detail
-
SerialLightManager
public SerialLightManager(SerialTrafficController tc)
-
-
Method Detail
-
getMemo
@Nonnull public SerialSystemConnectionMemo getMemo()
Get the system connection for this manager.
-
allowMultipleAdditions
public boolean allowMultipleAdditions(@Nonnull java.lang.String systemName)
Description copied from interface:NameIncrementingManager
Determines if it is possible to add a range of NamedBeans in numerical order for a particular system implementation.Default is not providing this service. Systems should override this method if they do provide the service.
- Parameters:
systemName
- the system name to check against; appears to be ignored in all implementations- Returns:
- true if possible; false otherwise
-
createNewLight
@Nonnull protected Light createNewLight(@Nonnull java.lang.String systemName, java.lang.String userName) throws java.lang.IllegalArgumentException
Method to create a new Light based on the system name Returns null if the system name is not in a valid format Assumes calling method has checked that a Light with this system name does not already exist- Specified by:
createNewLight
in classAbstractLightManager
- Parameters:
systemName
- the system name to use for this lightuserName
- the user name to use for this light- Returns:
- the new light or null if unsuccessful
- Throws:
java.lang.IllegalArgumentException
- something failed in the names
-
createNewSpecificLight
protected abstract Light createNewSpecificLight(java.lang.String systemName, java.lang.String userName)
Create light of a specific type for the interface- Parameters:
systemName
- name encoding deviceuserName
- user name- Returns:
- light object
-
validateSystemNameFormat
@Nonnull public java.lang.String validateSystemNameFormat(@Nonnull java.lang.String name, @Nonnull java.util.Locale locale)
Validate the format of name, returning it unchanged if valid.Although further restrictions may be added by system-specific implementations, at a minimum, the implementation must consider a name that does not start with the System Name prefix for this manager to be invalid, and must consider a name that is the same as the System Name prefix to be invalid.
Overriding implementations may rely on
Manager.validSystemNameFormat(java.lang.String)
, however they must provide an actionable message in the thrown exception if that method does not returnManager.NameValidity.VALID
. When overriding implementations of this method rely on validSystemNameFormat(), implementations of that method must not throw an exception, log an error, or otherwise disrupt the user.- Parameters:
name
- the system name to validatelocale
- the locale for a localized exception; this is needed for the JMRI web server, which supports multiple locales- Returns:
- the unchanged value of the name parameter
-
validSystemNameFormat
public Manager.NameValidity validSystemNameFormat(@Nonnull java.lang.String systemName)
Test if parameter is a properly formatted system name. Implementations of this method must not throw an exception, log an error, or otherwise disrupt the user.- Specified by:
validSystemNameFormat
in interfaceManager<Light>
- Overrides:
validSystemNameFormat
in classAbstractManager<Light>
- Parameters:
systemName
- the system name- Returns:
Manager.NameValidity.INVALID
if system name does not start withManager.getSystemNamePrefix()
;Manager.NameValidity.VALID_AS_PREFIX_ONLY
if system name equalsManager.getSystemNamePrefix()
; otherwiseManager.NameValidity.VALID
to allow Managers that do not perform more specific validation to be considered valid.
-
validSystemNameConfig
public boolean validSystemNameConfig(@Nonnull java.lang.String systemName)
Public method to validate system name for configuration- Parameters:
systemName
- the system name- Returns:
- 'true' if system name has a valid format, else return 'false'
-
getEntryToolTip
public java.lang.String getEntryToolTip()
Get a manager-specific tool tip for adding an entry to the manager.- Specified by:
getEntryToolTip
in interfaceManager<Light>
- Overrides:
getEntryToolTip
in classAbstractLightManager
- Returns:
- the tool tip or null to disable the tool tip
-
supportsVariableLights
public boolean supportsVariableLights(@Nonnull java.lang.String systemName)
Description copied from class:AbstractLightManager
Test if system in the given name can support a variable light.- Specified by:
supportsVariableLights
in interfaceLightManager
- Overrides:
supportsVariableLights
in classAbstractLightManager
- Parameters:
systemName
- the system name- Returns:
- 'true' to indicate this system can support variable lights
-
-