Package jmri.jmrit.logixng.implementation

Class DefaultStringActionManager

java.lang.Object

jmri.beans.PropertyChangeSupport

jmri.beans.VetoableChangeSupport

jmri.managers.AbstractManager<E>

jmri.jmrit.logixng.implementation.AbstractBaseManager<MaleStringActionSocket>

jmri.jmrit.logixng.implementation.DefaultStringActionManager

All Implemented Interfaces:

java.beans.PropertyChangeListener, java.beans.VetoableChangeListener, java.util.EventListener, PropertyChangeFirer, PropertyChangeProvider, SilenceablePropertyChangeProvider, VetoableChangeFirer, VetoableChangeProvider, BaseManager<MaleStringActionSocket>, StringActionManager, Manager<MaleStringActionSocket>

public class DefaultStringActionManager
extends AbstractBaseManager<MaleStringActionSocket>
implements StringActionManager

Class providing the basic logic of the ActionManager interface.

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) static DefaultStringActionManager	_instance

Fields inherited from class jmri.jmrit.logixng.implementation.AbstractBaseManager

_maleSocketFactories

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, PROPERTY_BEANS, PROPERTY_CAN_DELETE, PROPERTY_DISPLAY_LIST_NAME, PROPERTY_DO_DELETE, PROPERTY_DO_NOT_DELETE, PROPERTY_LENGTH, REPORTERS, ROUTES, SECTIONS, SENSORGROUPS, SENSORS, SIGNALGROUPS, SIGNALHEADS, SIGNALMASTLOGICS, SIGNALMASTS, STRINGIOS, TIMEBASE, TRANSITS, TURNOUTS, WARRANTS

Constructor Summary

Constructors

Constructor	Description
DefaultStringActionManager()

Method Summary

Modifier and Type	Method	Description
protected MaleStringActionSocket	castBean(MaleSocket maleSocket)	Cast the maleSocket to E This method is needed since SpotBugs @SuppressWarnings("unchecked") does not work for the cast: (E)socket.
FemaleStringActionSocket	createFemaleSocket(Base parent, FemaleSocketListener listener, java.lang.String socketName)
protected MaleStringActionSocket	createMaleActionSocket(StringActionBean action)
void	deleteStringAction(MaleStringActionSocket x)	Delete StringAction by removing it from the manager.
java.util.Map<Category,java.util.List<java.lang.Class<? extends Base>>>	getActionClasses()	Get a set of classes that implements the DigitalAction interface.
java.lang.String	getBeanTypeHandled(boolean plural)	Get the user-readable name of the type of NamedBean handled by this manager.
MaleSocket	getLastRegisteredMaleSocket()	Get the last item registered in the mananger.
java.lang.Class<? extends MaleSocket>	getMaleSocketClass()	Get the default male socket class
java.lang.Class<MaleStringActionSocket>	getNamedBeanClass()	Get the class of NamedBean supported by this Manager.
int	getXMLOrder()	Determine the order that types should be written when storing panel files.
static DefaultStringActionManager	instance()
MaleStringActionSocket	registerAction(StringActionBean action)	Remember a NamedBean Object created outside the manager.
MaleStringActionSocket	registerBean(MaleStringActionSocket maleSocket)	Remember a NamedBean Object created outside the manager.
char	typeLetter()

Methods inherited from class jmri.jmrit.logixng.implementation.AbstractBaseManager

deleteBean, deleteBean, deregister, fireVetoableChange, getOuterBean, register, registerMaleSocketFactory, validSystemNameFormat

Methods inherited from class jmri.managers.AbstractManager

addDataListener, checkNumeric, createSystemName, dispose, fireDataListenersAdded, fireDataListenersRemoved, fireVetoableChange, getAutoSystemName, getBySystemName, getBySystemName, getByUserName, getKnownBeanProperties, getMemo, getNamedBean, getNamedBeanSet, getObjectCount, getSystemPrefix, handleUserNameUniqueness, makeSystemName, propertyChange, 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.jmrit.logixng.BaseManager

deleteBean, registerMaleSocketFactory

Methods inherited from interface jmri.Manager

addDataListener, deleteBean, deregister, dispose, getBeanTypeHandled, getBySystemName, getByUserName, getEntryToolTip, getKnownBeanProperties, getMemo, getNamedBean, getNamedBeanSet, getObjectCount, 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.jmrit.logixng.StringActionManager

getAutoSystemName, getSubSystemNamePrefix

Methods inherited from interface jmri.beans.VetoableChangeProvider

addVetoableChangeListener, addVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, removeVetoableChangeListener, removeVetoableChangeListener

Field Detail

_instance

static volatile DefaultStringActionManager _instance

Constructor Detail

DefaultStringActionManager

public DefaultStringActionManager()

Method Detail

getMaleSocketClass

public java.lang.Class<? extends MaleSocket> getMaleSocketClass()

Get the default male socket class

Specified by:

getMaleSocketClass in interface BaseManager<MaleStringActionSocket>

Returns:

the class

createMaleActionSocket

protected MaleStringActionSocket createMaleActionSocket(StringActionBean action)

getLastRegisteredMaleSocket

public MaleSocket getLastRegisteredMaleSocket()

Get the last item registered in the mananger.

Specified by:

getLastRegisteredMaleSocket in interface BaseManager<MaleStringActionSocket>

Returns:

the last item

registerBean

public MaleStringActionSocket registerBean(MaleStringActionSocket maleSocket)

Remember a NamedBean Object created outside the manager.

The non-system-specific SignalHeadManagers use this method extensively.

Specified by:

registerBean in interface BaseManager<MaleStringActionSocket>

Overrides:

registerBean in class AbstractBaseManager<MaleStringActionSocket>

Parameters:

maleSocket - the bean

Returns:

the registered bean with attached male sockets

registerAction

public MaleStringActionSocket registerAction(@Nonnull
                                             StringActionBean action)
                                      throws java.lang.IllegalArgumentException

Remember a NamedBean Object created outside the manager. This method creates a MaleActionSocket for the action.

Specified by:

registerAction in interface StringActionManager

Parameters:

action - the bean

Returns:

the male socket for this action

Throws:

java.lang.IllegalArgumentException - if the action has an invalid system name

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 interface Manager<MaleStringActionSocket>

Returns:

write order for this Manager; larger is later.

typeLetter

public char typeLetter()

Specified by:

typeLetter in interface Manager<MaleStringActionSocket>

Returns:

The type letter for a specific implementation

createFemaleSocket

public FemaleStringActionSocket createFemaleSocket(Base parent,
                                                   FemaleSocketListener listener,
                                                   java.lang.String socketName)

Specified by:

createFemaleSocket in interface StringActionManager

getActionClasses

public java.util.Map<Category,java.util.List<java.lang.Class<? extends Base>>> getActionClasses()

Description copied from interface: StringActionManager

Get a set of classes that implements the DigitalAction interface.

Specified by:

getActionClasses in interface StringActionManager

Returns:

a set of entries with category and class

getBeanTypeHandled

public java.lang.String getBeanTypeHandled(boolean plural)

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 interface Manager<MaleStringActionSocket>

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

deleteStringAction

public void deleteStringAction(MaleStringActionSocket x)

Delete StringAction by removing it from the manager. The Action must first be deactivated so it stops processing.

Specified by:

deleteStringAction in interface StringActionManager

Parameters:

x - the StringAction to delete

instance

@InvokeOnGuiThread
public static DefaultStringActionManager instance()

getNamedBeanClass

public java.lang.Class<MaleStringActionSocket> getNamedBeanClass()

Description copied from interface: Manager

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 interface Manager<MaleStringActionSocket>

Returns:

the class supported by this Manager.

castBean

protected MaleStringActionSocket castBean(MaleSocket maleSocket)

Description copied from class: AbstractBaseManager

Cast the maleSocket to E This method is needed since SpotBugs @SuppressWarnings("unchecked") does not work for the cast: (E)socket.

Specified by:

castBean in class AbstractBaseManager<MaleStringActionSocket>

Parameters:

maleSocket - the maleSocket to cast

Returns:

the maleSocket as E