Interface DependencyResolver

All Superinterfaces:

Service

All Known Implementing Classes:

DefaultDependencyResolver

@Experimental
public interface DependencyResolver
extends Service

Collects, flattens and resolves dependencies.

Method Summary

Modifier and Type	Method	Description
default DependencyResolverResult	collect(DependencyResolverRequest request)	Collects the transitive dependencies and builds a dependency graph.
default DependencyResolverResult	collect(Session session, Artifact artifact, PathScope scope)	Collects the transitive dependencies of some artifacts and builds a dependency graph for the given path scope.
default DependencyResolverResult	collect(Session session, DependencyCoordinates root, PathScope scope)	Collects the transitive dependencies of some artifacts and builds a dependency graph for the given path scope.
default DependencyResolverResult	collect(Session session, Project project, PathScope scope)	Collects the transitive dependencies of some artifacts and builds a dependency graph for the given path scope.
default DependencyResolverResult	flatten(DependencyResolverRequest request)
List<Node>	flatten(Session session, Node node, PathScope scope)	Flattens a list of nodes.
default DependencyResolverResult	flatten(Session session, Project project, PathScope scope)
DependencyResolverResult	resolve(DependencyResolverRequest request)	This method collects, flattens and resolves the dependencies.
default DependencyResolverResult	resolve(Session session, List<DependencyCoordinates> dependencies)
default DependencyResolverResult	resolve(Session session, List<DependencyCoordinates> dependencies, PathScope scope)
default DependencyResolverResult	resolve(Session session, DependencyCoordinates dependency)
default DependencyResolverResult	resolve(Session session, DependencyCoordinates dependency, PathScope scope)
default DependencyResolverResult	resolve(Session session, Project project)
default DependencyResolverResult	resolve(Session session, Project project, PathScope scope)

Method Details

collect

@Nonnull
default DependencyResolverResult collect(@Nonnull
 Session session,
 @Nonnull
 DependencyCoordinates root,
 @Nonnull
 PathScope scope)

Collects the transitive dependencies of some artifacts and builds a dependency graph for the given path scope. Note that this operation is only concerned about determining the coordinates of the transitive dependencies and does not actually resolve the artifact files.

Parameters:

session - the Session, must not be null

root - the Maven Dependency, must not be null

scope - the {link PathScope} to collect dependencies, must not be null

Returns:

the collection result, never null

Throws:

DependencyResolverException - if the dependency tree could not be built

IllegalArgumentException - if an argument is null or invalid

See Also:

• collect(DependencyResolverRequest)

collect

@Nonnull
default DependencyResolverResult collect(@Nonnull
 Session session,
 @Nonnull
 Project project,
 @Nonnull
 PathScope scope)

Collects the transitive dependencies of some artifacts and builds a dependency graph for the given path scope. Note that this operation is only concerned about determining the coordinates of the transitive dependencies and does not actually resolve the artifact files.

Parameters:

session - the Session, must not be null

project - the Project, must not be null

scope - the {link PathScope} to collect dependencies, must not be null

Returns:

the collection result, never null

Throws:

DependencyResolverException - if the dependency tree could not be built

IllegalArgumentException - if an argument is null or invalid

See Also:

• collect(DependencyResolverRequest)

collect

@Nonnull
default DependencyResolverResult collect(@Nonnull
 Session session,
 @Nonnull
 Artifact artifact,
 @Nonnull
 PathScope scope)

Collects the transitive dependencies of some artifacts and builds a dependency graph for the given path scope. Note that this operation is only concerned about determining the coordinates of the transitive dependencies and does not actually resolve the artifact files.

Parameters:

session - the Session, must not be null

artifact - the Artifact, must not be null

scope - the {link PathScope} to collect dependencies, must not be null

Returns:

the collection result, never null

Throws:

DependencyResolverException - if the dependency tree could not be built

IllegalArgumentException - if an argument is null or invalid

See Also:

• collect(DependencyResolverRequest)

collect

@Nonnull
default DependencyResolverResult collect(@Nonnull
 DependencyResolverRequest request)

Collects the transitive dependencies and builds a dependency graph. Note that this operation is only concerned about determining the coordinates of the transitive dependencies and does not actually resolve the artifact files.

Parameters:

request - the dependency collection request, must not be null

Returns:

the collection result, never null

Throws:

DependencyResolverException - if the dependency tree could not be built

IllegalArgumentException - if an argument is null or invalid

See Also:

• collect(Session, Project, PathScope)
• collect(Session, DependencyCoordinates, PathScope)
• collect(Session, Artifact, PathScope)

flatten

List<Node> flatten(@Nonnull
 Session session,
 @Nonnull
 Node node,
 @Nullable
 PathScope scope)
            throws DependencyResolverException

Flattens a list of nodes. Note that the PathScope argument should usually be null as the dependency tree has been filtered during collection for the appropriate scope.

Parameters:

session - the Session, must not be null

node - the Node to flatten, must not be null

scope - an optional PathScope to filter out dependencies

Returns:

the flattened list of node

Throws:

DependencyResolverException

flatten

@Nonnull
default DependencyResolverResult flatten(@Nonnull
 Session session,
 @Nonnull
 Project project,
 @Nonnull
 PathScope scope)

flatten

@Nonnull
default DependencyResolverResult flatten(@Nonnull
 DependencyResolverRequest request)

resolve

@Nonnull
default DependencyResolverResult resolve(@Nonnull
 Session session,
 @Nonnull
 Project project)

resolve

@Nonnull
default DependencyResolverResult resolve(@Nonnull
 Session session,
 @Nonnull
 Project project,
 @Nonnull
 PathScope scope)

resolve

@Nonnull
default DependencyResolverResult resolve(@Nonnull
 Session session,
 @Nonnull
 DependencyCoordinates dependency)

resolve

@Nonnull
default DependencyResolverResult resolve(@Nonnull
 Session session,
 @Nonnull
 DependencyCoordinates dependency,
 @Nonnull
 PathScope scope)

resolve

@Nonnull
default DependencyResolverResult resolve(@Nonnull
 Session session,
 @Nonnull
 List<DependencyCoordinates> dependencies)

resolve

@Nonnull
default DependencyResolverResult resolve(@Nonnull
 Session session,
 @Nonnull
 List<DependencyCoordinates> dependencies,
 @Nonnull
 PathScope scope)

resolve

DependencyResolverResult resolve(DependencyResolverRequest request)
                          throws DependencyResolverException,
ArtifactResolverException

This method collects, flattens and resolves the dependencies.

Parameters:

request - the request to resolve

Returns:

the result of the resolution

Throws:

DependencyResolverException

ArtifactResolverException

See Also:

• collect(DependencyResolverRequest)
• flatten(Session, Node, PathScope)
• ArtifactResolver.resolve(ArtifactResolverRequest)