Class DefaultSignalMastManager
- All Implemented Interfaces:
PropertyChangeListener
,VetoableChangeListener
,EventListener
,PropertyChangeFirer
,PropertyChangeProvider
,SilenceablePropertyChangeProvider
,VetoableChangeFirer
,VetoableChangeProvider
,Manager<SignalMast>
,ProvidingManager<SignalMast>
,SignalMastManager
public class DefaultSignalMastManager extends AbstractManager<SignalMast> implements SignalMastManager
Note that this does not enforce any particular system naming convention at the present time. They're just names...
-
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) ArrayList<SignalMastRepeater>
repeaterList
Fields inherited from class jmri.managers.AbstractManager
_beans, _tsys, _tuser, lastAutoNamedBeanRef, memo, paddedNumber, silenceableProperties, silencedProperties
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_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 DefaultSignalMastManager(InternalSystemConnectionMemo memo)
-
Method Summary
Modifier and Type Method Description void
addRepeater(SignalMastRepeater rp)
String
getBeanTypeHandled(boolean plural)
Get the user-readable name of the type of NamedBean handled by this manager.SignalMast
getBySystemName(String key)
Locate an existing instance based on a system name.SignalMast
getByUserName(String key)
Locate an existing instance based on a user name.Class<SignalMast>
getNamedBeanClass()
Get the class of NamedBean supported by this Manager.List<SignalMastRepeater>
getRepeaterList()
SignalMast
getSignalMast(String name)
Get an existing SignalMast or return null if it doesn't exist.int
getXMLOrder()
Determine the order that types should be written when storing panel files.void
initialiseRepeaters()
SignalMast
provide(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.SignalMast
provideCustomSignalMast(String systemName, Class<? extends SignalMast> mastClass)
Retrieve or create a new signal mast with a given system name.SignalMastRepeater
provideRepeater(SignalMast master, SignalMast slave)
Creates or retrieves a signal mast repeater.SignalMast
provideSignalMast(String name)
Get the SignalMast with the user name, then system name if needed; if that fails, create a new SignalMast.SignalMast
provideSignalMast(String prefix, String signalSystem, String mastName, String[] heads)
void
removeRepeater(SignalMastRepeater rp)
char
typeLetter()
Methods inherited from class jmri.managers.AbstractManager
addDataListener, checkNumeric, createSystemName, deleteBean, deregister, dispose, fireDataListenersAdded, fireDataListenersRemoved, fireVetoableChange, getAutoSystemName, getBySystemName, getIncrement, getIncrementFromExistingNumber, getInstanceBySystemName, getInstanceByUserName, getKnownBeanProperties, getMemo, 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.Manager
addDataListener, deleteBean, deregister, getBeanBySystemName, getBeanByUserName, getBeanTypeHandled, getEntryToolTip, getKnownBeanProperties, getMemo, getNamedBean, getNamedBeanList, getNamedBeanSet, getObjectCount, getSubSystemNamePrefix, getSystemNameList, getSystemNamePrefix, getSystemPrefix, isValidSystemNameFormat, makeSystemName, makeSystemName, makeSystemName, register, removeDataListener, setDataListenerMute, setPropertyChangesMuted, validateBadCharsInSystemNameFormat, validateIntegerSystemNameFormat, validateNmraAccessorySystemNameFormat, validateSystemNameFormat, 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
-
Field Details
-
Constructor Details
-
Method Details
-
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<SignalMast>
- Returns:
- write order for this Manager; larger is later.
-
typeLetter
- Specified by:
typeLetter
in interfaceManager<SignalMast>
- Returns:
- The type letter for a specific implementation
-
getSignalMast
Description copied from interface:SignalMastManager
Get an existing SignalMast or return null if it doesn't exist. Locates via user name, then system name if needed.- Specified by:
getSignalMast
in interfaceSignalMastManager
- Parameters:
name
- User name or system name to match- Returns:
- null if no match found
-
provideSignalMast
@Nonnull public SignalMast provideSignalMast(@Nonnull String prefix, @Nonnull String signalSystem, @Nonnull String mastName, @Nonnull String[] heads)- Specified by:
provideSignalMast
in interfaceSignalMastManager
-
provideSignalMast
Description copied from interface:SignalMastManager
Get the SignalMast with the user name, then system name if needed; if that fails, create a new SignalMast. If the name is a valid system name, it will be used for the new SignalMast.- Specified by:
provideSignalMast
in interfaceSignalMastManager
- Parameters:
name
- User name, system name, or address which can be promoted to system name- Returns:
- never null
-
provideCustomSignalMast
@Nonnull public SignalMast provideCustomSignalMast(@Nonnull String systemName, Class<? extends SignalMast> mastClass) throws JmriExceptionDescription copied from interface:SignalMastManager
Retrieve or create a new signal mast with a given system name. If a new object is created, it is also registered in this manager.- Specified by:
provideCustomSignalMast
in interfaceSignalMastManager
- Parameters:
systemName
- the system name by which to look up the mast, or to create anew.mastClass
- specific signal mast class. Must have a single-argument string constructor to crete it by system name.- Returns:
- a registered signal mast (might be newly created),
- Throws:
JmriException
- if a signal mast with the given system name is already registered but it is not of the correct class, or an internal error happens during construction.
-
getBySystemName
Description copied from class:AbstractManager
Locate an existing instance based on a system name.- Specified by:
getBySystemName
in interfaceManager<SignalMast>
- Specified by:
getBySystemName
in interfaceSignalMastManager
- Overrides:
getBySystemName
in classAbstractManager<SignalMast>
- Parameters:
key
- System Name of the required NamedBean- Returns:
- requested NamedBean object or null if none exists
-
getByUserName
Description copied from class:AbstractManager
Locate an existing instance based on a user name.- Specified by:
getByUserName
in interfaceManager<SignalMast>
- Specified by:
getByUserName
in interfaceSignalMastManager
- Overrides:
getByUserName
in classAbstractManager<SignalMast>
- Parameters:
key
- System Name of the required NamedBean- Returns:
- requested NamedBean object or null if none exists
-
getBeanTypeHandled
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<SignalMast>
- 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
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<SignalMast>
- Returns:
- the class supported by this Manager.
-
provideRepeater
@Nonnull public SignalMastRepeater provideRepeater(@Nonnull SignalMast master, @Nonnull SignalMast slave) throws JmriExceptionCreates or retrieves a signal mast repeater.- Parameters:
master
- the mast for the master of the repeater.slave
- the mast for the slave of the repeater.- Returns:
- newly created (and registered) or existing signal mast repeater.
- Throws:
JmriException
- if the repeater already exists but the other direction.
-
addRepeater
- Throws:
JmriException
-
removeRepeater
-
getRepeaterList
-
initialiseRepeaters
-
provide
Description copied from interface:ProvidingManager
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 interfaceProvidingManager<SignalMast>
- Parameters:
name
- User name, system name, or address which can be promoted to system name- Returns:
- Never null
- Throws:
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.
-