Class SerialTurnoutManager

    • Method Detail

      • allowMultipleAdditions

        public boolean allowMultipleAdditions​(@Nonnull
                                              java.lang.String systemName)
        Description copied from interface: NameIncrementingManager
        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.

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

        public java.lang.String getNextValidSystemName​(@Nonnull
                                                       NamedBean currentBean)
                                                throws JmriException
        Description copied from interface: NameIncrementingManager
        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 NameIncrementingManager.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.

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

        protected Turnout createNewTurnout​(@Nonnull
                                           java.lang.String systemName,
                                           java.lang.String userName)
                                    throws java.lang.IllegalArgumentException
        Internal method to invoke the factory, after all the logic for returning an existing Turnout has been invoked.
        Specified by:
        createNewTurnout in class AbstractTurnoutManager
        systemName - the system name to use for the new Turnout
        userName - the user name to use for the new Turnout
        the new Turnout or
        java.lang.IllegalArgumentException - if unsuccessful
      • validateSystemNameFormat

        public java.lang.String validateSystemNameFormat​(@Nonnull
                                                         java.lang.String name,
                                                         java.util.Locale locale)
        Validate the format of name, returning it unchanged if valid.

        Although further restrictions may be added by system-specific implementations, at a minimum, the implementation must consider a name that does not start with the System Name prefix for this manager to be invalid, and must consider a name that is the same as the System Name prefix to be invalid.

        Overriding implementations may rely on Manager.validSystemNameFormat(java.lang.String), however they must provide an actionable message in the thrown exception if that method does not return Manager.NameValidity.VALID. When overriding implementations of this method rely on validSystemNameFormat(), implementations of that method must not throw an exception, log an error, or otherwise disrupt the user.

        name - the system name to validate
        locale - the locale for a localized exception; this is needed for the JMRI web server, which supports multiple locales
        the unchanged value of the name parameter