org.jasig.maven.notice.util.ResourceFinder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of maven-notice-plugin Show documentation

Generates Apache style NOTICE files

There is a newer version: 1.1.0

/**
 * Licensed to Jasig under one or more contributor license
 * agreements. See the NOTICE file distributed with this work
 * for additional information regarding copyright ownership.
 * Jasig licenses this file to you under the Apache License,
 * Version 2.0 (the "License"); you may not use this file
 * except in compliance with the License. You may obtain a
 * copy of the License at:
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on
 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.jasig.maven.notice.util;

import java.net.URL;
import java.util.List;

import org.apache.maven.plugin.MojoFailureException;

/**
 * @author Eric Dalquist
 * @version $Revision$
 */
public interface ResourceFinder {

    public void setCompileClassPath(List classpath);

    public void setPluginClassPath(ClassLoader classLoader);

    /**
     * Find a resource by searching:

     * 1. In the filesystem, relative to basedir

     * 2. In the filesystem, as an absolute path (or relative to current execution directory)

     * 3. In project classpath

     * 4. In plugin classpath

     * 5. As a URL
     *
     * @param resource The resource to get
     * @return A valid URL
     * @throws MojoFailureException If the resource is not found
     */
    public URL findResource(String resource) throws MojoFailureException;

}