Package jmri.jmrix.anyma

Class UsbLightManager

    • Method Detail

      • createNewLight

        @Nonnull
public Light createNewLight​(@Nonnull
                            java.lang.String systemName,
                            java.lang.String userName)
                     throws java.lang.IllegalArgumentException
        Create a new Light based on the system name and optional user name.

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

        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 - if the system name is not in a valid format or if the system name does not correspond to a valid channel

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

        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 - the system name to validate
        Returns:
        'true' if system name has a valid meaning in current configuration, else return 'false'

      • allowMultipleAdditions

        public boolean allowMultipleAdditions​(@Nonnull
                                      java.lang.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