org.codehaus.plexus.resource.loader.ResourceLoader Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of plexus-resources Show documentation

A component to transparently retrieve resources from the filesystem, classpath or internet.

There is a newer version: 1.3.0

package org.codehaus.plexus.resource.loader;

/*
 * The MIT License
 *
 * Copyright (c) 2004, The Codehaus
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
 * of the Software, and to permit persons to whom the Software is furnished to do
 * so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

import java.io.InputStream;

import org.codehaus.plexus.resource.PlexusResource;

/**
 * @author Trygve Laugstøl
 * @version $Id$
 */
public interface ResourceLoader
{
    String ROLE = ResourceLoader.class.getName();

    /**
     * @deprecated Use {@link #getResource(String)}.
     */
    InputStream getResourceAsInputStream( String name )
        throws ResourceNotFoundException;

    void addSearchPath( String path );

    /**
     * Returns the resource with the given name.
     * 
     * @param name The resources name.
     * @return The resource with the given name.
     * @throws ResourceNotFoundException The resource wasn't found, or wasn't available.
     */
    PlexusResource getResource( String name )
        throws ResourceNotFoundException;
}