Class HelpLocator


  • class HelpLocator
    extends java.lang.Object
    A helper class that assists the HelpManager by serving as a collection of Class loaders based on URL roots.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.util.List<java.lang.ClassLoader> classLoaders  
      private static org.apache.log4j.Logger logger  
    • Constructor Summary

      Constructors 
      Constructor Description
      HelpLocator()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      (package private) java.net.URL findResource​(java.lang.String name)
      Locates a help resource by using the internal resource locator collection.
      (package private) void installClassloaderLocator​(java.lang.ClassLoader cl)
      Adds a ClassLoader to be used as a help resource locator
      (package private) void installLocator​(java.net.URL url)
      Adds a new locator to the current set of locators by using the passed in URL as a base to locate help resources.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • classLoaders

        private java.util.List<java.lang.ClassLoader> classLoaders
      • logger

        private static org.apache.log4j.Logger logger
    • Constructor Detail

      • HelpLocator

        HelpLocator()
    • Method Detail

      • installClassloaderLocator

        void installClassloaderLocator​(java.lang.ClassLoader cl)
        Adds a ClassLoader to be used as a help resource locator
      • installLocator

        void installLocator​(java.net.URL url)
        Adds a new locator to the current set of locators by using the passed in URL as a base to locate help resources. The URL SHOULD end in a '/' character.
      • findResource

        java.net.URL findResource​(java.lang.String name)
        Locates a help resource by using the internal resource locator collection.
        Returns:
        URL of the located resource, or null if it cannot be located.