Package jmri.managers

Class ProxyStringIOManager

    • 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<StringIO>
        Returns:
        write order for this Manager; larger is later.

      • makeBean

        @Nonnull
protected StringIO makeBean​(Manager<StringIO> 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<StringIO>
        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.

      • getStringIO

        public StringIO getStringIO​(@Nonnull
                            java.lang.String name)
        Get an existing StringIO or return null if it doesn't exist. Locates via user name, then system name if needed.
        Specified by:
        getStringIO in interface StringIOManager
        Parameters:
        name - User name or system name to match
        Returns:
        null if no match found

      • newStringIO

        @Nonnull
public StringIO newStringIO​(@Nonnull
                            java.lang.String systemName,
                            java.lang.String userName)
                     throws java.lang.IllegalArgumentException
        Return a StringIO with the specified user or system name. Return StringIO by UserName else provide by SystemName.

        Note that two calls with the same arguments will get the same instance; there is only one StringIO object with a specific system or user name.

        This will always return a valid object reference; a new object will be created if necessary. If that's not possible, an IllegalArgumentException is thrown.

        If a new object has to be created:

        • If a null reference is given for user name, no user name will be associated with the Sensor 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 StringIOs when you should be looking them up.
        Specified by:
        newStringIO in interface StringIOManager
        Parameters:
        systemName - the desired system name
        userName - the desired user name
        Returns:
        requested StringIO object
        Throws:
        java.lang.IllegalArgumentException - if cannot create the StringIO due to e.g. an illegal name or name that can't be parsed.

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

      • provide

        @Nonnull
public StringIO 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 ProvidingManager<StringIO>
        Specified by:
        provide in interface StringIOManager
        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.

      • getNamedBeanClass

        public java.lang.Class<StringIO> 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<StringIO>
        Returns:
        the class supported by this Manager.