Package jmri.jmrix.openlcb

Class OlcbLightManager

    • Method Detail

      • createNewLight

        @Nonnull
protected Light createNewLight​(@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 method 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:
        never null
        Throws:
        java.lang.IllegalArgumentException - something failed in the names

      • startLoad

        public void startLoad()
        This function is invoked before an XML load is started. We defer initialization of the newly created lights until finishLoad because the feedback type might be changing as we are parsing the XML.

      • finishLoad

        public void finishLoad()
        This function is invoked after the XML load is complete and all lights are instantiated and their feedback type is read in. We use this hook to finalize the construction of the OpenLCB objects whose instantiation was deferred until the feedback type was known.

      • 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

      • validSystemNameConfig

        public boolean validSystemNameConfig​(@Nonnull
                                     java.lang.String address)
                              throws java.lang.IllegalArgumentException
        Description copied from interface: LightManager
        Test if parameter is a valid system name for current configuration.
        Parameters:
        address - the system name
        Returns:
        true if valid; false otherwise
        Throws:
        java.lang.IllegalArgumentException

      • validateSystemNameFormat

        @Nonnull
public java.lang.String validateSystemNameFormat​(@Nonnull
                                                 java.lang.String name,
                                                 @Nonnull
                                                 java.util.Locale locale)
                                          throws NamedBean.BadSystemNameException
        Validates to OpenLCB format. 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
        Throws:
        NamedBean.BadSystemNameException - if provided name is an invalid format