Package jmri

Interface NameIncrementingManager

All Known Subinterfaces:
LightManager, ReporterManager, SensorManager, StringIOManager, TurnoutManager
All Known Implementing Classes:
AbstractLightManager, AbstractReporterManager, AbstractSensorManager, AbstractStringIOManager, AbstractTurnoutManager, AcelaLightManager, AcelaSensorManager, AcelaTurnoutManager, BiDiBLightManager, BiDiBReporterManager, BiDiBSensorManager, BiDiBTurnoutManager, CbusLightManager, CbusReporterManager, CbusSensorManager, CbusTurnoutManager, ConcentratorReporterManager, ConcentratorSensorManager, Dcc4PcReporterManager, Dcc4PcSensorManager, DCCppLightManager, DCCppSensorManager, DCCppTurnoutManager, EasyDccTurnoutManager, EcosReporterManager, EcosSensorManager, EcosTurnoutManager, EliteXNetTurnoutManager, InternalLightManager, InternalReporterManager, InternalSensorManager, InternalStringIOManager, InternalTurnoutManager, IpocsLightManager, IpocsSensorManager, IpocsTurnoutManager, JMRIClientLightManager, JMRIClientReporterManager, JMRIClientSensorManager, JMRIClientTurnoutManager, LnLightManager, LnReporterManager, LnSensorManager, LnSensorManager, LnStringIOManager, LnTurnoutManager, MarklinSensorManager, MarklinTurnoutManager, MqttLightManager, MqttReporterManager, MqttSensorManager, MqttTurnoutManager, MrcTurnoutManager, Mx1TurnoutManager, NceLightManager, NceSensorManager, NceTurnoutManager, OlcbLightManager, OlcbReporterManager, OlcbSensorManager, OlcbStringIOManager, OlcbTurnoutManager, ProxyLightManager, ProxyReporterManager, ProxySensorManager, ProxyStringIOManager, ProxyTurnoutManager, RaspberryPiSensorManager, RaspberryPiTurnoutManager, RfidReporterManager, RfidSensorManager, RpsReporterManager, RpsSensorManager, SerialLightManager, SerialLightManager, SerialLightManager, SerialLightManager, SerialLightManager, SerialLightManager, SerialSensorManager, SerialSensorManager, SerialSensorManager, SerialSensorManager, SerialSensorManager, SerialSensorManager, SerialTurnoutManager, SerialTurnoutManager, SerialTurnoutManager, SerialTurnoutManager, SerialTurnoutManager, SerialTurnoutManager, SerialTurnoutManager, SpecificLightManager, SpecificLightManager, SpecificLightManager, SpecificLightManager, SpecificLightManager, SpecificSensorManager, SpecificSensorManager, SpecificSensorManager, SpecificSensorManager, SprogTurnoutManager, SRCPSensorManager, SRCPTurnoutManager, StandaloneReporterManager, StandaloneSensorManager, TamsSensorManager, TamsTurnoutManager, UsbLightManager, XBeeLightManager, XBeeSensorManager, XBeeTurnoutManager, XNetLightManager, XNetSensorManager, XNetTurnoutManager, XpaTurnoutManager, Z21ReporterManager, Z21SensorManager, Z21XNetTurnoutManager, ZTC611XNetTurnoutManager
public interface NameIncrementingManager
Interface that indicates that a Manager class capable of providing the next system name after the name of a given NamedBean.

This is used for e.g. providing a range of NamedBeans

  • Method Summary

    Modifier and Type
    Method
    Description
    default boolean
    allowMultipleAdditions(String systemName)
    Determines if it is possible to add a range of NamedBeans in numerical order for a particular system implementation.
    default String
    getNextValidSystemName(NamedBean currentBean)
    Get the next valid NamedBean system name.

  • Method Details

    • allowMultipleAdditions

      @CheckReturnValue default boolean allowMultipleAdditions(@Nonnull String systemName)
      Determines if it is possible to add a range of NamedBeans in numerical order for a particular system implementation.

      Default is not providing this service. Systems should override this method if they do provide the service.

      Parameters:
      systemName - the system name to check against; appears to be ignored in all implementations
      Returns:
      true if possible; false otherwise

    • getNextValidSystemName

      @Nonnull @CheckReturnValue default String getNextValidSystemName(@Nonnull NamedBean currentBean) throws JmriException
      Get the next valid NamedBean system name.

      For example, if the system name of the provided NamedBean is IS10, the next valid name is IS11.

      This should not be called if allowMultipleAdditions(java.lang.String) returns false.

      Pays no attention to whether the next NamedBean already exists or not, just works out the name. Nor is there any guarantee that the return value can actually be created: a provide() call on the return value can still perhaps fail in some circumstances.

      In some cases, there is no clear next address. In that case, a JmriException is thrown. For example, some systems have no concept of a "next" address; Internal sensors don't necessarily have numeric suffixes; etc.

      Default implementation works for names of the form (prefix)(type letter)(numeric string) by incrementing the numeric string as needed.

      Parameters:
      currentBean - The NamedBean who's system name that provides the base for "next"
      Returns:
      The next valid system name
      Throws:
      JmriException - If unable to create a valid next address