Class ProxyLightManager
- java.lang.Object
-
- jmri.beans.PropertyChangeSupport
-
- jmri.beans.VetoableChangeSupport
-
- jmri.managers.AbstractProxyManager<E>
-
- jmri.managers.AbstractProvidingProxyManager<Light>
-
- jmri.managers.ProxyLightManager
-
- All Implemented Interfaces:
java.beans.PropertyChangeListener
,java.util.EventListener
,PropertyChangeFirer
,PropertyChangeProvider
,SilenceablePropertyChangeProvider
,VetoableChangeFirer
,VetoableChangeProvider
,LightManager
,Manager<Light>
,Manager.ManagerDataListener<Light>
,NameIncrementingManager
,ProvidingManager<Light>
,ProxyManager<Light>
public class ProxyLightManager extends AbstractProvidingProxyManager<Light> implements LightManager
Implementation of a LightManager that can serve as a proxy for multiple system-specific implementations.
-
-
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 inherited from class jmri.managers.AbstractProxyManager
defaultManager, listeners, 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 ProxyLightManager()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
activateAllLights()
Activate the control mechanism for each Light controlled by this LightManager.boolean
allowMultipleAdditions(java.lang.String systemName)
A method that determines if it is possible to add a range of lights in numerical order eg 11 thru 18, primarily used to show/not show the add range box in the add Light window.java.lang.String
convertSystemNameToAlternate(java.lang.String systemName)
Convert a system name to an alternate format Locate a system specfic LightManager based on a system name.java.lang.String
getBeanTypeHandled(boolean plural)
Get the user-readable name of the type of NamedBean handled by this manager.Light
getLight(java.lang.String name)
Locate via user name, then system name if needed.java.lang.Class<Light>
getNamedBeanClass()
Get the class of NamedBean supported by this Manager.int
getXMLOrder()
Determine the order that types should be written when storing panel files.protected Light
makeBean(Manager<Light> manager, java.lang.String systemName, java.lang.String userName)
Defer creation of the proper type to the subclass.protected AbstractManager<Light>
makeInternalManager()
Create specific internal manager as needed for concrete type.Light
newLight(java.lang.String systemName, java.lang.String userName)
Return a Light with the specified user or system name.Light
provide(java.lang.String name)
Get an existing instance via user name, then system name; if no matching instance is found, create a new NameBean from the system name.Light
provideLight(java.lang.String name)
Locate via user name, then system name if needed.boolean
supportsVariableLights(java.lang.String systemName)
Responds 'true' if Light Manager is for a System that supports variable Lights.boolean
validSystemNameConfig(java.lang.String systemName)
Validate system name against the hardware configuration Locate a system specific LightManager based on a system name.-
Methods inherited from class jmri.managers.AbstractProvidingProxyManager
newNamedBean, provideNamedBean
-
Methods inherited from class jmri.managers.AbstractProxyManager
addDataListener, addManager, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, addVetoableChangeListener, contentsChanged, createSystemManager, createSystemName, createSystemName, deleteBean, deregister, dispose, getBySystemName, getByUserName, getDefaultManager, getDisplayOrderManagerList, getEntryToolTip, getInternalManager, getKnownBeanProperties, getManager, getManagerList, getManagerOrDefault, getMemo, getNamedBean, getNamedBeanSet, getNextValidSystemName, getObjectCount, getSystemPrefix, initInternal, intervalAdded, intervalRemoved, makeSystemName, propertyChange, recomputeNamedBeanSet, register, removeDataListener, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, removeVetoableChangeListener, setDataListenerMute, setPropertyChangesSilenced, typeLetter, validateSystemNameFormat, validSystemNameFormat
-
Methods inherited from class jmri.beans.VetoableChangeSupport
fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, getVetoableChangeListeners, getVetoableChangeListeners
-
Methods inherited from class jmri.beans.PropertyChangeSupport
fireIndexedPropertyChange, fireIndexedPropertyChange, fireIndexedPropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeListeners, getPropertyChangeListeners
-
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
-
Methods inherited from interface jmri.Manager
addDataListener, deleteBean, deregister, getBeanTypeHandled, getEntryToolTip, getKnownBeanProperties, getMemo, getNamedBean, getNamedBeanSet, getObjectCount, getSubSystemNamePrefix, getSystemNamePrefix, getSystemPrefix, isValidSystemNameFormat, makeSystemName, makeSystemName, makeSystemName, register, removeDataListener, setDataListenerMute, typeLetter, validateBadCharsInSystemNameFormat, validateIntegerSystemNameFormat, validateNmraAccessorySystemNameFormat, validateSystemNameFormat, validateSystemNameFormat, validateSystemNameFormatOnlyNumeric, validateSystemNamePrefix, validateTrimmedMin1NumberSystemNameFormat, validateTrimmedSystemNameFormat, validateUppercaseTrimmedSystemNameFormat, validSystemNameFormat
-
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
-
ProxyLightManager
public ProxyLightManager()
-
-
Method Detail
-
getXMLOrder
public int getXMLOrder()
Description copied from interface:Manager
Determine the order that types should be written when storing panel files. Uses one of the constants defined in this class.Yes, that's an overly-centralized methodology, but it works for now.
- Specified by:
getXMLOrder
in interfaceManager<Light>
- Returns:
- write order for this Manager; larger is later.
-
makeInternalManager
protected AbstractManager<Light> makeInternalManager()
Description copied from class:AbstractProxyManager
Create specific internal manager as needed for concrete type.- Specified by:
makeInternalManager
in classAbstractProxyManager<Light>
- Returns:
- an internal manager
-
getLight
public Light getLight(@Nonnull java.lang.String name)
Locate via user name, then system name if needed.- Specified by:
getLight
in interfaceLightManager
- Parameters:
name
- User name, system name, or address which can be promoted to system name- Returns:
- Null if nothing by that name exists
-
makeBean
@Nonnull protected Light makeBean(Manager<Light> manager, java.lang.String systemName, java.lang.String userName) throws java.lang.IllegalArgumentException
Defer creation of the proper type to the subclass.- Specified by:
makeBean
in classAbstractProvidingProxyManager<Light>
- Parameters:
manager
- the manager to invokesystemName
- the system nameuserName
- the user name- Returns:
- a bean
- Throws:
java.lang.IllegalArgumentException
- if unable to make.
-
provide
@Nonnull public Light provide(@Nonnull java.lang.String name) throws java.lang.IllegalArgumentException
Get an existing instance via user name, then system name; if no matching instance is found, create a new NameBean from the system name.If the name is a valid system name, it will be used for the new NamedBean. Otherwise, the
Manager.makeSystemName(java.lang.String)
method will attempt to turn it into a valid system name which the manager will attempt to use. If that fails, an exception is thrown.This is similar to the specific methods found in certain type-specific managers:
TurnoutManager.provideTurnout(java.lang.String)
,SensorManager.provideSensor(java.lang.String)
, et al. Those might be more mnemonic; this one is more generic. Neither is preferred nor deprecated; use your choice.- Specified by:
provide
in interfaceLightManager
- Specified by:
provide
in interfaceProvidingManager<Light>
- Parameters:
name
- User name, system name, or address which can be promoted to system name- Returns:
- Never null
- Throws:
java.lang.IllegalArgumentException
- if NamedBean doesn't already exist and the manager cannot create it due to an illegal name or name that can't be parsed.
-
provideLight
@Nonnull public Light provideLight(@Nonnull java.lang.String name) throws java.lang.IllegalArgumentException
Locate via user name, then system name if needed. If that fails, create a new Light: If the name is a valid system name, it will be used for the new Light. Otherwise, the makeSystemName method will attempt to turn it into a valid system name.- Specified by:
provideLight
in interfaceLightManager
- Parameters:
name
- User name, system name, or address which can be promoted to system name- Returns:
- Never null under normal circumstances
- Throws:
java.lang.IllegalArgumentException
-
newLight
@Nonnull public Light newLight(@Nonnull java.lang.String systemName, java.lang.String userName) throws java.lang.IllegalArgumentException
Return a Light with the specified user or system name. Lookup Light by UserName, then Provide New Light by SystemName. Note that two calls with the same arguments will get the same instance; there is only one Light object representing a given physical Light and therefore only one with a specific system or user name.This will always return a valid object reference; a new object will be created if necessary. In that case:
- If a null reference is given for user name, no user name will be associated with the Light object created; a valid system name must be provided
- If both names are provided, the system name defines the hardware access of the desired sensor, and the user address is associated with it. The system name must be valid.
- Specified by:
newLight
in interfaceLightManager
- Parameters:
systemName
- the desired system nameuserName
- the desired user name- Returns:
- requested Light object (never null)
- Throws:
java.lang.IllegalArgumentException
- if cannot create the Light due to e.g. an illegal name or name that can't be parsed.
-
validSystemNameConfig
public boolean validSystemNameConfig(@Nonnull java.lang.String systemName)
Validate system name against the hardware configuration Locate a system specific LightManager based on a system name.- Specified by:
validSystemNameConfig
in interfaceLightManager
- Parameters:
systemName
- the system name- Returns:
- if a manager is found, return its determination of validity of system name format relative to the hardware configuration; false if no manager exists.
-
convertSystemNameToAlternate
@Nonnull public java.lang.String convertSystemNameToAlternate(@Nonnull java.lang.String systemName)
Convert a system name to an alternate format Locate a system specfic LightManager based on a system name. Returns "" if no manager exists. If a manager is found, return its determination of an alternate system name- Specified by:
convertSystemNameToAlternate
in interfaceLightManager
- Parameters:
systemName
- the system name to convert- Returns:
- an alternate name
-
activateAllLights
public void activateAllLights()
Activate the control mechanism for each Light controlled by this LightManager. Relay this call to all LightManagers.- Specified by:
activateAllLights
in interfaceLightManager
-
supportsVariableLights
public boolean supportsVariableLights(@Nonnull java.lang.String systemName)
Responds 'true' if Light Manager is for a System that supports variable Lights. Returns false if no manager exists. If a manager is found, return its determination of support for variable lights.- Specified by:
supportsVariableLights
in interfaceLightManager
- Parameters:
systemName
- the system name- Returns:
- true if variable lights are supported; false otherwise
-
allowMultipleAdditions
public boolean allowMultipleAdditions(@Nonnull java.lang.String systemName)
A method that determines if it is possible to add a range of lights in numerical order eg 11 thru 18, primarily used to show/not show the add range box in the add Light window.- Specified by:
allowMultipleAdditions
in interfaceNameIncrementingManager
- Parameters:
systemName
- the system name to check against; appears to be ignored in all implementations- Returns:
- true if possible; false otherwise
-
getBeanTypeHandled
@Nonnull public java.lang.String getBeanTypeHandled(boolean plural)
Description copied from interface:Manager
Get the user-readable name of the type of NamedBean handled by this manager.For instance, in the code where we are dealing with just a bean and a message that needs to be passed to the user or in a log.
- Specified by:
getBeanTypeHandled
in interfaceManager<Light>
- Parameters:
plural
- true to return plural form of the type; false to return singular form- Returns:
- a string of the bean type that the manager handles, eg Turnout, Sensor etc
-
getNamedBeanClass
public java.lang.Class<Light> getNamedBeanClass()
Get the class of NamedBean supported by this Manager. This should be the generic class used in the Manager's class declaration.- Specified by:
getNamedBeanClass
in interfaceManager<Light>
- Returns:
- the class supported by this Manager.
-
-