Package jmri.managers

Class ProxyLightManager

    • Method Detail

      • getXMLOrder

        public int getXMLOrder()
        Description copied from interface: Manager
        Determine the order that types should be written when storing panel files. Uses one of the constants defined in this class.

        Yes, that's an overly-centralized methodology, but it works for now.

        Specified by:
        getXMLOrder in interface Manager<Light>
        Returns:
        write order for this Manager; larger is later.

      • getLight

        public Light getLight​(@Nonnull
                      java.lang.String name)
        Locate via user name, then system name if needed.
        Specified by:
        getLight in interface LightManager
        Parameters:
        name - User name, system name, or address which can be promoted to system name
        Returns:
        Null if nothing by that name exists

      • makeBean

        @Nonnull
protected Light makeBean​(Manager<Light> manager,
                         java.lang.String systemName,
                         java.lang.String userName)
                  throws java.lang.IllegalArgumentException
        Defer creation of the proper type to the subclass.
        Specified by:
        makeBean in class AbstractProvidingProxyManager<Light>
        Parameters:
        manager - the manager to invoke
        systemName - the system name
        userName - the user name
        Returns:
        a bean
        Throws:
        java.lang.IllegalArgumentException - if unable to make.

      • provide

        @Nonnull
public Light provide​(@Nonnull
                     java.lang.String name)
              throws java.lang.IllegalArgumentException
        Get an existing instance via user name, then system name; if no matching instance is found, create a new NameBean from the system name.

        If the name is a valid system name, it will be used for the new NamedBean. Otherwise, the Manager.makeSystemName(java.lang.String) method will attempt to turn it into a valid system name which the manager will attempt to use. If that fails, an exception is thrown.

        This is similar to the specific methods found in certain type-specific managers: TurnoutManager.provideTurnout(java.lang.String), SensorManager.provideSensor(java.lang.String), et al. Those might be more mnemonic; this one is more generic. Neither is preferred nor deprecated; use your choice.

        Specified by:
        provide in interface LightManager
        Specified by:
        provide in interface ProvidingManager<Light>
        Parameters:
        name - User name, system name, or address which can be promoted to system name
        Returns:
        Never null
        Throws:
        java.lang.IllegalArgumentException - if NamedBean doesn't already exist and the manager cannot create it due to an illegal name or name that can't be parsed.

      • provideLight

        @Nonnull
public Light provideLight​(@Nonnull
                          java.lang.String name)
                   throws java.lang.IllegalArgumentException
        Locate via user name, then system name if needed. If that fails, create a new Light: If the name is a valid system name, it will be used for the new Light. Otherwise, the makeSystemName method will attempt to turn it into a valid system name.
        Specified by:
        provideLight in interface LightManager
        Parameters:
        name - User name, system name, or address which can be promoted to system name
        Returns:
        Never null under normal circumstances
        Throws:
        java.lang.IllegalArgumentException

      • newLight

        @Nonnull
public Light newLight​(@Nonnull
                      java.lang.String systemName,
                      java.lang.String userName)
               throws java.lang.IllegalArgumentException
        Return a Light with the specified user or system name. Lookup Light by UserName, then Provide New Light by SystemName. Note that two calls with the same arguments will get the same instance; there is only one Light object representing a given physical Light and therefore only one with a specific system or user name.

        This will always return a valid object reference; a new object will be created if necessary. In that case:

        • If a null reference is given for user name, no user name will be associated with the Light object created; a valid system name must be provided
        • If both names are provided, the system name defines the hardware access of the desired sensor, and the user address is associated with it. The system name must be valid.
        Note that it is possible to make an inconsistent request if both addresses are provided, but the given values are associated with different objects. This is a problem, and we don't have a good solution except to issue warnings. This will mostly happen if you're creating Lights when you should be looking them up.
        Specified by:
        newLight in interface LightManager
        Parameters:
        systemName - the desired system name
        userName - the desired user name
        Returns:
        requested Light object (never null)
        Throws:
        java.lang.IllegalArgumentException - if cannot create the Light due to e.g. an illegal name or name that can't be parsed.

      • validSystemNameConfig

        public boolean validSystemNameConfig​(@Nonnull
                                     java.lang.String systemName)
        Validate system name against the hardware configuration Locate a system specific LightManager based on a system name.
        Specified by:
        validSystemNameConfig in interface LightManager
        Parameters:
        systemName - the system name
        Returns:
        if a manager is found, return its determination of validity of system name format relative to the hardware configuration; false if no manager exists.

      • convertSystemNameToAlternate

        @Nonnull
public java.lang.String convertSystemNameToAlternate​(@Nonnull
                                                     java.lang.String systemName)
        Convert a system name to an alternate format Locate a system specfic LightManager based on a system name. Returns "" if no manager exists. If a manager is found, return its determination of an alternate system name
        Specified by:
        convertSystemNameToAlternate in interface LightManager
        Parameters:
        systemName - the system name to convert
        Returns:
        an alternate name

      • activateAllLights

        public void activateAllLights()
        Activate the control mechanism for each Light controlled by this LightManager. Relay this call to all LightManagers.
        Specified by:
        activateAllLights in interface LightManager

      • supportsVariableLights

        public boolean supportsVariableLights​(@Nonnull
                                      java.lang.String systemName)
        Responds 'true' if Light Manager is for a System that supports variable Lights. Returns false if no manager exists. If a manager is found, return its determination of support for variable lights.
        Specified by:
        supportsVariableLights in interface LightManager
        Parameters:
        systemName - the system name
        Returns:
        true if variable lights are supported; false otherwise

      • 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.
        Specified by:
        allowMultipleAdditions in interface NameIncrementingManager
        Parameters:
        systemName - the system name to check against; appears to be ignored in all implementations
        Returns:
        true if possible; false otherwise

      • getBeanTypeHandled

        @Nonnull
public java.lang.String getBeanTypeHandled​(boolean plural)
        Description copied from interface: Manager
        Get the user-readable name of the type of NamedBean handled by this manager.

        For instance, in the code where we are dealing with just a bean and a message that needs to be passed to the user or in a log.

        Specified by:
        getBeanTypeHandled in interface Manager<Light>
        Parameters:
        plural - true to return plural form of the type; false to return singular form
        Returns:
        a string of the bean type that the manager handles, eg Turnout, Sensor etc

      • getNamedBeanClass

        public java.lang.Class<Light> getNamedBeanClass()
        Get the class of NamedBean supported by this Manager. This should be the generic class used in the Manager's class declaration.
        Specified by:
        getNamedBeanClass in interface Manager<Light>
        Returns:
        the class supported by this Manager.