org.jboss.forge.project.dependencies
Interface DependencyResolverProvider

All Known Implementing Classes:

RepositoryLookup

public interface DependencyResolverProvider

Used to resolve Dependency versions, DependencyResource artifacts, and dependencies of a given Dependency

Example usage:

 @Inject
 DepenencyResolver resolver;
 
 Dependency query =
          DependencyBuilder.create("com.example:example:[1.0],[2.0,)");
 
 List<Dependency> versions = resolver.resolveVersions(query);
 List<DependencyResource> artifacts = resolver.resolveArtifacts(query);
 List<DependencyResource> dependencies = resolver.resolveDependencies(query);
 

Version query syntax is as follows:

1.0	version == 1.0
[1.0,2.0)	1.0 <= version < 2.0
[1.0,2.0]	1.0 <= version <= 2.0
[1.5,)	1.5 <= version
(,1.0],[1.2,)	version <= 1.0, and version >= 2.0

Implementing additional DependencyResolverProvider classes DependencyResolverProvider defines the interface to be used when creating additional providers for DependencyResolver using the ServiceLoader interface.

A service provider is identified by placing a provider-configuration file in the META-INF/services directory:

/META-INF/services/org.jboss.forge.project.dependencies.DependencyResolverProvider

The file contains a list of fully-qualified class names of concrete implementation classes, one per line. Space and tab characters surrounding each name, as well as blank lines, are ignored.

For example:

 /META-INF/services/org.jboss.forge.project.dependencies.DependencyResolverProvider

 #this file contains a line for each implementation
 com.example.MyCustomImplementation
 

Author:

Lincoln Baxter, III

Method Summary

List<DependencyResource>	resolveArtifacts(Dependency query) Resolve a set of DependencyResource artifacts matching the given query, searching in the default repository.
List<DependencyResource>	resolveArtifacts(Dependency query, DependencyRepository repository) Resolve a set of DependencyResource artifacts matching the given query, searching in only the given DependencyRepository.
List<DependencyResource>	resolveArtifacts(Dependency dep, List<DependencyRepository> repositories) Resolve a set of DependencyResource artifacts matching the given query, searching in only the given list of DependencyRepository instances.
List<DependencyResource>	resolveDependencies(Dependency query) Resolve a set of DependencyResource dependencies for the given query, searching in the default repository.
List<DependencyResource>	resolveDependencies(Dependency query, DependencyRepository repository) Resolve a set of DependencyResource dependencies for the given query, searching in only the given DependencyRepository.
List<DependencyResource>	resolveDependencies(Dependency dep, List<DependencyRepository> repositories) Resolve a set of DependencyResource dependencies for the given query, searching in only the given list of DependencyRepository instances.
DependencyMetadata	resolveDependencyMetadata(Dependency query) Resolve DependencyMetadata for a given Dependency, searching the default repository.
DependencyMetadata	resolveDependencyMetadata(Dependency query, DependencyRepository repository) Resolve DependencyMetadata for a given Dependency, searching only the given DependencyRepository.
DependencyMetadata	resolveDependencyMetadata(Dependency query, List<DependencyRepository> repositories) Resolve DependencyMetadata for a given Dependency, searching only the given DependencyRepository instances.
List<Dependency>	resolveVersions(Dependency query) Resolve a set of Dependency versions matching the given query, searching in the default repository.
List<Dependency>	resolveVersions(Dependency query, DependencyRepository repository) Resolve a set of Dependency versions matching the given query, searching in only the given DependencyRepository.
List<Dependency>	resolveVersions(Dependency dep, List<DependencyRepository> repositories) Resolve a set of Dependency versions matching the given query, searching in only the given list of DependencyRepository instances.

Method Detail

resolveArtifacts

List<DependencyResource> resolveArtifacts(Dependency query)

Resolve a set of DependencyResource artifacts matching the given query, searching in the default repository.

resolveArtifacts

List<DependencyResource> resolveArtifacts(Dependency query,
                                          DependencyRepository repository)

Resolve a set of DependencyResource artifacts matching the given query, searching in only the given DependencyRepository.

resolveArtifacts

List<DependencyResource> resolveArtifacts(Dependency dep,
                                          List<DependencyRepository> repositories)

Resolve a set of DependencyResource artifacts matching the given query, searching in only the given list of DependencyRepository instances.

resolveDependencies

List<DependencyResource> resolveDependencies(Dependency query)

Resolve a set of DependencyResource dependencies for the given query, searching in the default repository.

Returns:

a list of DependencyResource dependencies on which the given query artifact depends.

resolveDependencies

List<DependencyResource> resolveDependencies(Dependency query,
                                             DependencyRepository repository)

Resolve a set of DependencyResource dependencies for the given query, searching in only the given DependencyRepository.

Returns:

a list of DependencyResource dependencies on which the given query artifact depends.

resolveDependencies

List<DependencyResource> resolveDependencies(Dependency dep,
                                             List<DependencyRepository> repositories)

Resolve a set of DependencyResource dependencies for the given query, searching in only the given list of DependencyRepository instances.

Returns:

a list of DependencyResource dependencies on which the given query artifact depends.

resolveDependencyMetadata

DependencyMetadata resolveDependencyMetadata(Dependency query)

Resolve DependencyMetadata for a given Dependency, searching the default repository. This returns information about the configured repositories, dependencies, and managed dependencies of the specified query.

Note: This method does not accept version ranges. A single version must be specified.

Valid query version: 1.0
Invalid query version: [1.0,2.0]

resolveDependencyMetadata

DependencyMetadata resolveDependencyMetadata(Dependency query,
                                             DependencyRepository repository)

Resolve DependencyMetadata for a given Dependency, searching only the given DependencyRepository. This returns information about the configured repositories, dependencies, and managed dependencies of the specified query.

Note: This method does not accept version ranges. A single version must be specified.

Valid query version: 1.0
Invalid query version: [1.0,2.0]

resolveDependencyMetadata

DependencyMetadata resolveDependencyMetadata(Dependency query,
                                             List<DependencyRepository> repositories)

Resolve DependencyMetadata for a given Dependency, searching only the given DependencyRepository instances. This returns information about the configured repositories, dependencies, and managed dependencies of the specified query.

Note: This method does not accept version ranges. A single version must be specified.

Valid query version: 1.0
Invalid query version: [1.0,2.0]

resolveVersions

List<Dependency> resolveVersions(Dependency query)

Resolve a set of Dependency versions matching the given query, searching in the default repository.

resolveVersions

List<Dependency> resolveVersions(Dependency query,
                                 DependencyRepository repository)

Resolve a set of Dependency versions matching the given query, searching in only the given DependencyRepository.

resolveVersions

List<Dependency> resolveVersions(Dependency dep,
                                 List<DependencyRepository> repositories)

Resolve a set of Dependency versions matching the given query, searching in only the given list of DependencyRepository instances.