Package jmri.jmrix.openlcb

Class OlcbLightManager

java.lang.Object

jmri.beans.PropertyChangeSupport

jmri.beans.VetoableChangeSupport

jmri.managers.AbstractManager<Light>

jmri.managers.AbstractLightManager

jmri.jmrix.openlcb.OlcbLightManager

All Implemented Interfaces:

PropertyChangeListener, VetoableChangeListener, EventListener, PropertyChangeFirer, PropertyChangeProvider, SilenceablePropertyChangeProvider, VetoableChangeFirer, VetoableChangeProvider, LightManager, Manager<Light>, ProvidingManager<Light>

public class OlcbLightManager
extends AbstractLightManager

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.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, deprecatedManagerLogger, ENTRYEXIT, IDTAGS, LAYOUTBLOCKS, LIGHTS, LOGIXNG_ANALOG_ACTIONS, LOGIXNG_ANALOG_EXPRESSIONS, LOGIXNG_CONDITIONALNGS, LOGIXNG_DIGITAL_ACTIONS, LOGIXNG_DIGITAL_BOOLEAN_ACTIONS, LOGIXNG_DIGITAL_EXPRESSIONS, 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
OlcbLightManager(CanSystemConnectionMemo memo)

Method Summary

Modifier and Type	Method	Description
boolean	allowMultipleAdditions(String systemName)	Test if possible to generate multiple lights given a numerical range to complete the system name.
protected Light	createNewLight(String systemName, String userName)	Internal method to invoke the factory, after all the logic for returning an existing method has been invoked.
void	finishLoad()	This function is invoked after the XML load is complete and all lights are instantiated and their feedback type is read in.
String	getEntryToolTip()	Get a manager-specific tool tip for adding an entry to the manager.
List<NamedBeanPropertyDescriptor<?>>	getKnownBeanProperties()	By default there are no custom properties.
CanSystemConnectionMemo	getMemo()	Get the system connection for this manager.
void	startLoad()	This function is invoked before an XML load is started.
String	validateSystemNameFormat(String name, Locale locale)	Validates to OpenLCB format.
boolean	validSystemNameConfig(String address)	Test if parameter is a valid system name for current configuration.

Methods inherited from class jmri.managers.AbstractLightManager

activateAllLights, convertSystemNameToAlternate, getBeanTypeHandled, getLight, getNamedBeanClass, getXMLOrder, newLight, provideLight, supportsVariableLights, typeLetter

Methods inherited from class jmri.managers.AbstractManager

addDataListener, checkNumeric, createSystemName, deleteBean, deregister, dispose, fireDataListenersAdded, fireDataListenersRemoved, fireVetoableChange, getAutoSystemName, getBySystemName, getBySystemName, getByUserName, getIncrement, getIncrementFromExistingNumber, getInstanceBySystemName, getInstanceByUserName, getNamedBean, getNamedBeanList, getNamedBeanSet, getNextValidAddress, getNextValidAddress, getObjectCount, getSystemNameList, getSystemPrefix, handleUserNameUniqueness, makeSystemName, propertyChange, register, registerSelf, registerUserName, removeDataListener, setDataListenerMute, setPropertyChangesSilenced, updateAutoNumber, validSystemNameFormat, 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, getNextValidAddress, provide

Methods inherited from interface jmri.Manager

addDataListener, deleteBean, deregister, getBeanBySystemName, getBeanByUserName, getBeanTypeHandled, getNamedBean, getNamedBeanList, getNamedBeanSet, getObjectCount, getSubSystemNamePrefix, getSystemNameList, getSystemNamePrefix, getSystemPrefix, isValidSystemNameFormat, makeSystemName, makeSystemName, makeSystemName, register, removeDataListener, setDataListenerMute, setPropertyChangesMuted, validateBadCharsInSystemNameFormat, validateIntegerSystemNameFormat, validateNmraAccessorySystemNameFormat, validateSystemNameFormat, validateSystemNameFormatOnlyNumeric, validateSystemNamePrefix, validateTrimmedMin1NumberSystemNameFormat, validateTrimmedSystemNameFormat, validateUppercaseTrimmedSystemNameFormat, validSystemNameFormat

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 Details

OlcbLightManager

public OlcbLightManager(CanSystemConnectionMemo memo)

Method Details

getMemo

@Nonnull public CanSystemConnectionMemo getMemo()

Get the system connection for this manager.

Specified by:

getMemo in interface Manager<Light>

Overrides:

getMemo in class AbstractManager<Light>

Returns:

the system connection for this manager

getKnownBeanProperties

@Nonnull public List<NamedBeanPropertyDescriptor<?>> getKnownBeanProperties()

Description copied from class: AbstractManager

By default there are no custom properties.

Specified by:

getKnownBeanProperties in interface Manager<Light>

Overrides:

getKnownBeanProperties in class AbstractManager<Light>

Returns:

empty list

createNewLight

@Nonnull protected Light createNewLight(@Nonnull String systemName, String userName) throws IllegalArgumentException

Internal method to invoke the factory, after all the logic for returning an existing method has been invoked.

Specified by:

createNewLight in class AbstractLightManager

Parameters:

systemName - the system name to use for this light

userName - the user name to use for this light

Returns:

never null

Throws:

IllegalArgumentException

startLoad

public void startLoad()

This function is invoked before an XML load is started. We defer initialization of the newly created lights until finishLoad because the feedback type might be changing as we are parsing the XML.

finishLoad

public void finishLoad()

This function is invoked after the XML load is complete and all lights are instantiated and their feedback type is read in. We use this hook to finalize the construction of the OpenLCB objects whose instantiation was deferred until the feedback type was known.

allowMultipleAdditions

public boolean allowMultipleAdditions(@Nonnull String systemName)

Description copied from class: AbstractLightManager

Test if possible to generate multiple lights given a numerical range to complete the system name.

Specified by:

allowMultipleAdditions in interface LightManager

Overrides:

allowMultipleAdditions in class AbstractLightManager

Parameters:

systemName - the system name

Returns:

true if multiple lights can be created at once; false otherwise

validSystemNameConfig

public boolean validSystemNameConfig(@Nonnull String address) throws IllegalArgumentException

Description copied from interface: LightManager

Test if parameter is a valid system name for current configuration.

Parameters:

address - the system name

Returns:

true if valid; false otherwise

Throws:

IllegalArgumentException

validateSystemNameFormat

@Nonnull public String validateSystemNameFormat(@Nonnull String name, @Nonnull Locale locale) throws NamedBean.BadSystemNameException

Validates to OpenLCB format. 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 return Manager.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 validate

locale - 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

Throws:

NamedBean.BadSystemNameException - if provided name is an invalid format

getEntryToolTip

public String getEntryToolTip()

Get a manager-specific tool tip for adding an entry to the manager.

Specified by:

getEntryToolTip in interface Manager<Light>

Overrides:

getEntryToolTip in class AbstractLightManager

Returns:

the tool tip or null to disable the tool tip