Package jmri.jmrix.acela

Class AcelaTurnoutManager

    • Method Detail

      • createNewTurnout

        @Nonnull
protected Turnout createNewTurnout​(@Nonnull
                                   java.lang.String systemName,
                                   java.lang.String userName)
                            throws java.lang.IllegalArgumentException
        Method to create a new Turnout based on the system name.

        Assumes calling method has checked that a Turnout with this system name does not already exist. Internal method to invoke the factory, after all the logic for returning an existing Turnout has been invoked.

        Specified by:
        createNewTurnout in class AbstractTurnoutManager
        Parameters:
        systemName - the system name to use for the new Turnout
        userName - the user name to use for the new Turnout
        Returns:
        the new Turnout or
        Throws:
        java.lang.IllegalArgumentException - if unsuccessful

      • validateSystemNameFormat

        @Nonnull
public java.lang.String validateSystemNameFormat​(@Nonnull
                                                 java.lang.String systemName,
                                                 @Nonnull
                                                 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.

        Verifies system name has valid prefix and is an integer from 0 to 16383.

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

      • validSystemNameConfig

        public boolean validSystemNameConfig​(@Nonnull
                                     java.lang.String systemName)
        Public method to validate system name for configuration.
        Parameters:
        systemName - system name to validate
        Returns:
        'true' if system name has a valid meaning in the current configuration, else return 'false'

      • convertSystemNameToAlternate

        public java.lang.String convertSystemNameToAlternate​(java.lang.String systemName)
        Public method to convert system name to its alternate format.
        Parameters:
        systemName - system name to convert
        Returns:
        a normalized system name if system name is valid and has a valid alternate representation, else return ""

      • 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.

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