Class DefaultSignalMastManager
- java.lang.Object
-
- jmri.beans.PropertyChangeSupport
-
- jmri.beans.VetoableChangeSupport
-
- jmri.managers.AbstractManager<SignalMast>
-
- jmri.managers.DefaultSignalMastManager
-
- All Implemented Interfaces:
java.beans.PropertyChangeListener
,java.beans.VetoableChangeListener
,java.util.EventListener
,PropertyChangeFirer
,PropertyChangeProvider
,SilenceablePropertyChangeProvider
,VetoableChangeFirer
,VetoableChangeProvider
,Manager<SignalMast>
,ProvidingManager<SignalMast>
,SignalMastManager
public class DefaultSignalMastManager extends AbstractManager<SignalMast> implements SignalMastManager
Default implementation of a 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 inherited from class jmri.managers.AbstractManager
_beans, _tsys, _tuser, lastAutoNamedBeanRef, memo, paddedNumber, 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 DefaultSignalMastManager(InternalSystemConnectionMemo memo)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description (package private) void
addListeners()
void
addRepeater(SignalMastRepeater rp)
void
dispose()
Free resources when no longer used.java.lang.String
getBeanTypeHandled(boolean plural)
Get the user-readable name of the type of NamedBean handled by this manager.SignalMast
getBySystemName(java.lang.String key)
Locate an existing instance based on a system name.SignalMast
getByUserName(java.lang.String key)
Locate an existing instance based on a user name.java.lang.Class<SignalMast>
getNamedBeanClass()
Get the class of NamedBean supported by this Manager.java.util.List<SignalMastRepeater>
getRepeaterList()
SignalMast
getSignalMast(java.lang.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(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.SignalMast
provideCustomSignalMast(java.lang.String systemName, java.lang.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(java.lang.String name)
Get the SignalMast with the user name, then system name if needed; if that fails, create a new SignalMast.SignalMast
provideSignalMast(java.lang.String prefix, java.lang.String signalSystem, java.lang.String mastName, java.lang.String[] heads)
void
removeRepeater(SignalMastRepeater rp)
char
typeLetter()
-
Methods inherited from class jmri.managers.AbstractManager
addDataListener, checkNumeric, createSystemName, deleteBean, deregister, fireDataListenersAdded, fireDataListenersRemoved, fireVetoableChange, getAutoSystemName, getBySystemName, getKnownBeanProperties, getMemo, getNamedBean, getNamedBeanSet, getObjectCount, getOuterBean, getSystemPrefix, handleUserNameUniqueness, makeSystemName, propertyChange, register, registerSelf, registerUserName, removeDataListener, setDataListenerMute, setPropertyChangesSilenced, setRegisterSelf, 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, getBeanTypeHandled, getEntryToolTip, getKnownBeanProperties, getMemo, getNamedBean, getNamedBeanSet, getObjectCount, getSubSystemNamePrefix, getSystemNamePrefix, getSystemPrefix, isValidSystemNameFormat, makeSystemName, makeSystemName, makeSystemName, register, removeDataListener, setDataListenerMute, 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
-
-
-
-
Constructor Detail
-
DefaultSignalMastManager
public DefaultSignalMastManager(InternalSystemConnectionMemo memo)
-
-
Method Detail
-
addListeners
final void addListeners()
-
getXMLOrder
public int getXMLOrder()
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
public char typeLetter()
- Specified by:
typeLetter
in interfaceManager<SignalMast>
- Returns:
- The type letter for a specific implementation
-
getSignalMast
@CheckForNull public SignalMast getSignalMast(@Nonnull java.lang.String name)
Get an existing SignalMast or return null if it doesn't exist. Locates via user name, then system name if needed. Searches by UserName then SystemName.- 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 java.lang.String prefix, @Nonnull java.lang.String signalSystem, @Nonnull java.lang.String mastName, @Nonnull java.lang.String[] heads) throws JmriException
- Specified by:
provideSignalMast
in interfaceSignalMastManager
- Throws:
JmriException
-
provideSignalMast
@Nonnull public SignalMast provideSignalMast(@Nonnull java.lang.String name) throws java.lang.IllegalArgumentException
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
- Throws:
java.lang.IllegalArgumentException
- if SignalMast doesn't already exist and the manager cannot create the SignalMast due to an illegal name or name that can't be parsed
-
provideCustomSignalMast
@Nonnull public SignalMast provideCustomSignalMast(@Nonnull java.lang.String systemName, java.lang.Class<? extends SignalMast> mastClass) throws JmriException
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
@CheckForNull public SignalMast getBySystemName(@Nonnull java.lang.String key)
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
@CheckForNull public SignalMast getByUserName(@Nonnull java.lang.String key)
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
@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<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
public java.lang.Class<SignalMast> 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 JmriException
Creates 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
public void addRepeater(SignalMastRepeater rp) throws JmriException
- Throws:
JmriException
-
removeRepeater
public void removeRepeater(SignalMastRepeater rp)
-
getRepeaterList
public java.util.List<SignalMastRepeater> getRepeaterList()
-
initialiseRepeaters
public void initialiseRepeaters()
-
provide
@Nonnull public SignalMast provide(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 interfaceProvidingManager<SignalMast>
- 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.
-
dispose
public void dispose()
Free resources when no longer used. Specifically, remove all references to and from this object, so it can be garbage-collected.- Specified by:
dispose
in interfaceManager<SignalMast>
- Specified by:
dispose
in interfaceSignalMastManager
- Overrides:
dispose
in classAbstractManager<SignalMast>
-
-