Package org.jboss.modules

Class AbstractResourceLoader

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected AbstractResourceLoader()
      Construct a new instance.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      ClassSpec getClassSpec​(java.lang.String fileName)
      Get the class specification for the given class name.
      java.lang.String getLibrary​(java.lang.String name)
      Get the absolute physical filesystem path for a library with the given name.
      PackageSpec getPackageSpec​(java.lang.String name)
      Get the package specification for the given directory name.
      protected static PackageSpec getPackageSpec​(java.lang.String name, java.util.jar.Manifest manifest, java.net.URL rootUrl)
      Convenience method to get a package specification from a Manifest.
      java.util.Collection<java.lang.String> getPaths()
      Get the collection of resource paths.
      Resource getResource​(java.lang.String name)
      Get a resource with the given name.
      java.lang.String getRootName()
      Get the name of the root represented by this resource loader.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • AbstractResourceLoader

        protected AbstractResourceLoader()
        Construct a new instance.

    • Method Detail

      • getPackageSpec

        protected static PackageSpec getPackageSpec​(java.lang.String name,
                                            java.util.jar.Manifest manifest,
                                            java.net.URL rootUrl)
        Convenience method to get a package specification from a Manifest.
        Parameters:
        name - the (dot-separated) package name
        manifest - the Manifest instance
        rootUrl - the code source URL
        Returns:
        the package specification

      • getRootName

        public java.lang.String getRootName()
        Description copied from interface: ResourceLoader
        Get the name of the root represented by this resource loader.
        Specified by:
        getRootName in interface ResourceLoader
        Returns:
        the name of the root

      • getClassSpec

        public ClassSpec getClassSpec​(java.lang.String fileName)
                       throws java.io.IOException
        Description copied from interface: ResourceLoader
        Get the class specification for the given class name. If no matching class is found, null is returned.
        Specified by:
        getClassSpec in interface ResourceLoader
        Parameters:
        fileName - the fileName of the class, e.g. for the class org.jboss.modules.ResourceLoader the fileName will be org/jboss/modules/ResourceLoader.class
        Returns:
        the class specification, or null if the named class is not found
        Throws:
        java.io.IOException - if an I/O error occurs

      • getPackageSpec

        public PackageSpec getPackageSpec​(java.lang.String name)
                           throws java.io.IOException
        Description copied from interface: ResourceLoader
        Get the package specification for the given directory name. Always returns a package specification; this method cannot be used to test for the existence of a package. A package spec should always be acquired from the same resource loader which provided the class specification. The directory name will always be specified using "/" separators.
        Specified by:
        getPackageSpec in interface ResourceLoader
        Parameters:
        name - the directory name
        Returns:
        the package specification
        Throws:
        java.io.IOException - if an I/O error occurs

      • getResource

        public Resource getResource​(java.lang.String name)
        Description copied from interface: ResourceLoader
        Get a resource with the given name. If no such resource is available, null is returned. The resource name will always be specified using "/" separators for the directory segments.
        Specified by:
        getResource in interface ResourceLoader
        Parameters:
        name - the resource name
        Returns:
        the resource, or null if it is not available

      • getLibrary

        public java.lang.String getLibrary​(java.lang.String name)
        Description copied from interface: ResourceLoader
        Get the absolute physical filesystem path for a library with the given name. The resultant path should be path-separated using "/" characters.
        Specified by:
        getLibrary in interface ResourceLoader
        Parameters:
        name - the name
        Returns:
        the path or null if the library is not present

      • getPaths

        public java.util.Collection<java.lang.String> getPaths()
        Description copied from interface: ResourceLoader
        Get the collection of resource paths. Called one time only when the resource loader is initialized. The paths should use "/" characters to separate the path segments.
        Specified by:
        getPaths in interface ResourceLoader
        Returns:
        the resource paths