Package jmri.managers

Class ProxyReporterManager

java.lang.Object
jmri.beans.PropertyChangeSupport
jmri.beans.VetoableChangeSupport
jmri.managers.AbstractProxyManager<E>
jmri.managers.AbstractProvidingProxyManager<Reporter>
jmri.managers.ProxyReporterManager
All Implemented Interfaces:
PropertyChangeListener, EventListener, PropertyChangeFirer, PropertyChangeProvider, SilenceablePropertyChangeProvider, VetoableChangeFirer, VetoableChangeProvider, Manager<Reporter>, Manager.ManagerDataListener<Reporter>, NameIncrementingManager, ProvidingManager<Reporter>, ProxyManager<Reporter>, ReporterManager
public class ProxyReporterManager extends AbstractProvidingProxyManager<Reporter> implements ReporterManager
Implementation of a ReporterManager that can serve as a proxy for multiple system-specific implementations.

  • Constructor Details

  • Method Details

    • makeInternalManager

      protected AbstractManager<Reporter> makeInternalManager()
      Description copied from class: AbstractProxyManager
      Create specific internal manager as needed for concrete type.
      Specified by:
      makeInternalManager in class AbstractProxyManager<Reporter>
      Returns:
      an internal manager

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

    • getReporter

      @CheckForNull public Reporter getReporter(@Nonnull String name)
      Locate via user name, then system name if needed.
      Specified by:
      getReporter in interface ReporterManager
      Parameters:
      name - User name or system name to match
      Returns:
      Null if nothing by that name exists

    • makeBean

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

    • provideReporter

      @Nonnull public Reporter provideReporter(@Nonnull String sName) throws IllegalArgumentException
      Description copied from interface: ReporterManager
      Locate via user name, then system name if needed. If that fails, create a new Reporter. If the name is a valid system name, it will be used for the new Reporter. Otherwise, the makeSystemName method will attempt to turn it into a valid system name.

      This provides the same function as ProvidingManager.provide(java.lang.String) which has a more generic form.

      Specified by:
      provideReporter in interface ReporterManager
      Parameters:
      sName - User name, system name, or address which can be promoted to system name
      Returns:
      Never null
      Throws:
      IllegalArgumentException - if Reporter doesn't already exist and the manager cannot create the Reporter due to an illegal name or name that can't be parsed.

    • provide

      @Nonnull public Reporter provide(@Nonnull String name) throws 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<Reporter>
      Specified by:
      provide in interface ReporterManager
      Parameters:
      name - User name, system name, or address which can be promoted to system name
      Returns:
      Never null
      Throws:
      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.

    • getByDisplayName

      @CheckForNull public Reporter getByDisplayName(@Nonnull String key)
      Description copied from interface: ReporterManager
      Locate an instance based on a user name, or if that fails, by system name. Returns null if no instance already exists.
      Specified by:
      getByDisplayName in interface ReporterManager
      Parameters:
      key - the name to locate
      Returns:
      requested Reporter object or null if none exists

    • newReporter

      @Nonnull public Reporter newReporter(@Nonnull String systemName, String userName) throws IllegalArgumentException
      Get an instance with the specified system and user names. Note that two calls with the same arguments will get the same instance; there is only one Reporter object representing a given physical Reporter and therefore only one with a specific system or user name.

      This will always return a valid object reference for a valid request; 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 Reporter object created; a valid system name must be provided
      • If a null reference is given for the system name, a system name will _somehow_ be inferred from the user name. How this is done is system specific.
      • If both names are provided, the system name defines the hardware access of the desired Reporter, and the user address is associated with it.
      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 Reporters when you should be looking them up.
      Specified by:
      newReporter in interface ReporterManager
      Parameters:
      systemName - the system name
      userName - the user name
      Returns:
      requested Reporter object (never null)
      Throws:
      IllegalArgumentException - if cannot create the Reporter due to an illegal name or name that can't be parsed.

    • allowMultipleAdditions

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

      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 String getBeanTypeHandled(boolean plural)
      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<Reporter>
      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 Class<Reporter> 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<Reporter>
      Returns:
      the class supported by this Manager.