org.jboss.modules.ResourceLoader Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source.
* Copyright 2010, Red Hat, Inc., and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.modules;
import java.io.IOException;
import java.util.Collection;
/**
* A loader for resources from a specific resource root within a module.
*
* @author David M. Lloyd
*/
public interface ResourceLoader {
/**
* Get the name of the root represented by this resource loader.
*
* @return the name of the root
*/
String getRootName();
/**
* Get the class specification for the given class name. If no matching class is found, {@code null} is returned.
*
* @param fileName the fileName of the class, e.g. for the class org.jboss.modules.ResourceLoader
* the fileName will be org/jboss/modules/ResourceLoader.class
* @return the class specification, or {@code null} if the named class is not found
* @throws IOException if an I/O error occurs
*/
ClassSpec getClassSpec(String fileName) throws IOException;
/**
* 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 "{@code /}" separators.
*
* @param name the directory name
* @return the package specification
* @throws IOException if an I/O error occurs
*/
PackageSpec getPackageSpec(String name) throws IOException;
/**
* Get a resource with the given name. If no such resource is available, {@code null} is returned.
* The resource name will always be specified using "{@code /}" separators for the directory segments.
*
* @param name the resource name
* @return the resource, or {@code null} if it is not available
*/
Resource getResource(String name);
/**
* Get the absolute physical filesystem path for a library with the given name. The resultant path should be
* path-separated using "{@code /}" characters.
*
* @param name the name
* @return the path or {@code null} if the library is not present
*/
String getLibrary(String name);
/**
* Get the collection of resource paths. Called one time only when the resource loader is initialized. The
* paths should use "{@code /}" characters to separate the path segments.
*
* @return the resource paths
*/
Collection getPaths();
}