Package jmri.jmrix.nce

Class NceLightManager

    • Method Detail

      • createNewLight

        @Nonnull
protected Light createNewLight​(@Nonnull
                               java.lang.String systemName,
                               java.lang.String userName)
                        throws java.lang.IllegalArgumentException
        Method to create a new Light based on the system name Assumes calling method has checked that a Light with this system name does not already exist
        Specified by:
        createNewLight in class AbstractLightManager
        Parameters:
        systemName - the system name to use for this light
        userName - the user name to use for this light
        Returns:
        the new light or null if unsuccessful
        Throws:
        java.lang.IllegalArgumentException - something failed in the names

      • getBitFromSystemName

        public int getBitFromSystemName​(java.lang.String systemName)
        Get the bit address from the system name.
        Parameters:
        systemName - system name for light
        Returns:
        index value for light

      • allowMultipleAdditions

        public boolean allowMultipleAdditions​(@Nonnull
                                      java.lang.String systemName)
        A method that determines if it is possible to add a range of lights in numerical order eg 11 thru 18, primarily used to show/not show the add range box in the add Light window
        Parameters:
        systemName - the system name to check against; appears to be ignored in all implementations
        Returns:
        true if possible; false otherwise

      • validateSystemNameFormat

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

        Parameters:
        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
        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 - the system name
        Returns:
        'true' if system name has a valid meaning in current configuration, else returns 'false'. For now, this method always returns 'true'; it is needed for the Abstract Light class.