Package jmri.jmrit.logixng
Interface StringActionManager
-
- All Superinterfaces:
BaseManager<MaleStringActionSocket>
,Manager<MaleStringActionSocket>
,PropertyChangeProvider
,SilenceablePropertyChangeProvider
,VetoableChangeProvider
- All Known Implementing Classes:
DefaultStringActionManager
public interface StringActionManager extends BaseManager<MaleStringActionSocket>
Manager for StringActionBean
-
-
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 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
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description FemaleStringActionSocket
createFemaleSocket(Base parent, FemaleSocketListener listener, java.lang.String socketName)
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
getAutoSystemName()
Create a new system name for an StringActionBean.default java.lang.String
getSubSystemNamePrefix()
Get the sub system prefix of this manager.MaleStringActionSocket
registerAction(StringActionBean action)
Remember a NamedBean Object created outside the manager.-
Methods inherited from interface jmri.jmrit.logixng.BaseManager
deleteBean, getLastRegisteredMaleSocket, getMaleSocketClass, registerBean, registerMaleSocketFactory
-
Methods inherited from interface jmri.Manager
addDataListener, deleteBean, deregister, dispose, getBeanTypeHandled, getBeanTypeHandled, getBySystemName, getByUserName, getEntryToolTip, getKnownBeanProperties, getMemo, getNamedBean, getNamedBeanClass, getNamedBeanSet, getObjectCount, getSystemNamePrefix, getSystemPrefix, getXMLOrder, isValidSystemNameFormat, makeSystemName, makeSystemName, makeSystemName, register, removeDataListener, setDataListenerMute, typeLetter, 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
-
-
-
-
Method Detail
-
registerAction
MaleStringActionSocket registerAction(@Nonnull StringActionBean action) throws java.lang.IllegalArgumentException
Remember a NamedBean Object created outside the manager. This method creates a MaleStringActionSocket for the action.- Parameters:
action
- the bean- Returns:
- the male socket for this action
- Throws:
java.lang.IllegalArgumentException
- if the action has an invalid system name
-
getAutoSystemName
java.lang.String getAutoSystemName()
Create a new system name for an StringActionBean.- Returns:
- a new system name
-
createFemaleSocket
FemaleStringActionSocket createFemaleSocket(Base parent, FemaleSocketListener listener, java.lang.String socketName)
-
getActionClasses
java.util.Map<Category,java.util.List<java.lang.Class<? extends Base>>> getActionClasses()
Get a set of classes that implements the DigitalAction interface.- Returns:
- a set of entries with category and class
-
getSubSystemNamePrefix
default java.lang.String getSubSystemNamePrefix()
Get the sub system prefix of this manager. The sub system prefix is the system name prefix and possibly some extra characters of the NamedBeans handled by this manager.For most managers, this is the same as
Manager.getSystemNamePrefix()
, but for some like the managers in LogixNG, it differs. The sub system prefix for the StringActionManager isManager.getSystemNamePrefix()
and "SA";- Specified by:
getSubSystemNamePrefix
in interfaceManager<MaleStringActionSocket>
- Returns:
- the sub system prefix
-
deleteStringAction
void deleteStringAction(MaleStringActionSocket x)
Delete StringAction by removing it from the manager. The Action must first be deactivated so it stops processing.- Parameters:
x
- the StringAction to delete
-
-