Class JMRIClientLightManager

    • Method Detail

      • createNewLight

        @Nonnull
        protected Light createNewLight​(@Nonnull
                                       java.lang.String systemName,
                                       java.lang.String userName)
                                throws java.lang.IllegalArgumentException
        Description copied from class: AbstractLightManager
        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 - something failed in the names
      • 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 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
        Parameters:
        systemName - the system name
        Returns:
        true if valid; false otherwise