com.marvelution.maven.components.dependency.resolver.methods.ResolveMethod Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of maven-dependency-resolver Show documentation

Maven 2.x Plexus component to resolve dependencies from jar files

The newest version!

/*
 * Licensed to Marvelution under one or more contributor license 
 * agreements.  See the NOTICE file distributed with this work 
 * for additional information regarding copyright ownership.
 * Marvelution 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 com.marvelution.maven.components.dependency.resolver.methods;

import java.io.File;

import org.apache.maven.artifact.Artifact;

import com.marvelution.maven.components.dependency.resolver.environment.ResolveEnvironment;
import com.marvelution.maven.components.dependency.resolver.methods.exception.ResolveMethodException;

/**
 * Resolve Method interface
 * 
 * @author Mark Rekveld
 */
public interface ResolveMethod {

	/**
	 * The Plexus role.
	 */
	String ROLE = ResolveMethod.class.getName();

	/**
	 * Default artifact type
	 */
	String DEFAULT_ARTIFACT_TYPE = "jar";

	/**
	 * Resolve a Library {@link File} to a {@link Artifact}
	 * 
	 * @param library the Library {@link File}
	 * @param environment environment the artfifact repositories, proxy settings, artifact factory/resolver, etc. to
	 *            use during resolve
	 * @return {@link Artifact}, may be null
	 * @throws ResolveMethodException in case of resolve exceptions
	 */
	Artifact resolve(final File library, final ResolveEnvironment environment) throws ResolveMethodException;

}