Package org.apache.maven.api.services

Interface DependencyResolverRequest

All Superinterfaces:

RepositoryAwareRequest, Request<Session>

@Experimental
@Immutable
public interface DependencyResolverRequest
extends RepositoryAwareRequest

A request to collect the transitive dependencies and to build a dependency graph from them. There are three ways to create a dependency graph. First, only the root dependency can be given. Second, a root dependency and direct dependencies can be specified in which case the specified direct dependencies are merged with the direct dependencies retrieved from the artifact descriptor of the root dependency. And last, only direct dependencies can be specified in which case the root node of the resulting graph has no associated dependency.

Since:

4.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	DependencyResolverRequest.DependencyResolverRequestBuilder
static enum	DependencyResolverRequest.RequestType

Method Summary

Modifier and Type	Method	Description
static DependencyResolverRequest	build(Session session, DependencyResolverRequest.RequestType requestType, List<DependencyCoordinates> dependencies)
static DependencyResolverRequest	build(Session session, DependencyResolverRequest.RequestType requestType, List<DependencyCoordinates> dependencies, PathScope scope)
static DependencyResolverRequest	build(Session session, DependencyResolverRequest.RequestType requestType, Artifact rootArtifact)
static DependencyResolverRequest	build(Session session, DependencyResolverRequest.RequestType requestType, Artifact rootArtifact, PathScope scope)
static DependencyResolverRequest	build(Session session, DependencyResolverRequest.RequestType requestType, DependencyCoordinates dependency)
static DependencyResolverRequest	build(Session session, DependencyResolverRequest.RequestType requestType, DependencyCoordinates dependency, PathScope scope)
static DependencyResolverRequest	build(Session session, DependencyResolverRequest.RequestType requestType, Project project)
static DependencyResolverRequest	build(Session session, DependencyResolverRequest.RequestType requestType, Project project, PathScope scope)
static DependencyResolverRequest.DependencyResolverRequestBuilder	builder()
Collection<DependencyCoordinates>	getDependencies()
Collection<DependencyCoordinates>	getManagedDependencies()
PathScope	getPathScope()
Predicate<PathType>	getPathTypeFilter()	Returns a filter for the types of path (class-path, module-path, …) accepted by the tool.
Optional<Project>	getProject()
DependencyResolverRequest.RequestType	getRequestType()
Optional<DependencyCoordinates>	getRoot()
Optional<Artifact>	getRootArtifact()
Version	getTargetVersion()	Returns the version of the platform where the code will be executed.
boolean	getVerbose()

Methods inherited from interface org.apache.maven.api.services.RepositoryAwareRequest

getRepositories, validate

Methods inherited from interface org.apache.maven.api.services.Request

equals, getSession, getTrace, hashCode, toString

Method Details

getRequestType

@Nonnull
DependencyResolverRequest.RequestType getRequestType()

getProject

@Nonnull
Optional<Project> getProject()

getRootArtifact

@Nonnull
Optional<Artifact> getRootArtifact()

getRoot

@Nonnull
Optional<DependencyCoordinates> getRoot()

getDependencies

@Nonnull
Collection<DependencyCoordinates> getDependencies()

getManagedDependencies

@Nonnull
Collection<DependencyCoordinates> getManagedDependencies()

getVerbose

boolean getVerbose()

getPathScope

@Nonnull
PathScope getPathScope()

getPathTypeFilter

@Nullable
Predicate<PathType> getPathTypeFilter()

Returns a filter for the types of path (class-path, module-path, …) accepted by the tool. For example, if a Java tools accepts only class-path elements, then the filter should return true for JavaPathType.CLASSES and false for JavaPathType.MODULES. If no filter is explicitly set, then the default is a filter accepting everything.

Returns:

a filter for the types of path (class-path, module-path, …) accepted by the tool

getTargetVersion

@Nullable
Version getTargetVersion()

Returns the version of the platform where the code will be executed. It should be the highest value of the <targetVersion> elements inside the <source> elements of a POM file.

Application to Java

In the context of a Java project, this is the value given to the --release compiler option. This value can determine whether a dependency will be placed on the class-path or on the module-path. For example, if the module-info.class entry of a JAR file exists only in the META-INF/versions/17/ sub-directory, then the default location of that dependency will be the module-path only if the --release option is equal or greater than 17.

If this value is not provided, then the default value in the context of Java projects is the Java version on which Maven is running, as given by Runtime.version().

Returns:

version of the platform where the code will be executed, or null for default

See Also:

• SourceRoot.targetVersion()

builder

@Nonnull
static DependencyResolverRequest.DependencyResolverRequestBuilder builder()

build

@Nonnull
static DependencyResolverRequest build(Session session,
 DependencyResolverRequest.RequestType requestType,
 Artifact rootArtifact)

build

@Nonnull
static DependencyResolverRequest build(Session session,
 DependencyResolverRequest.RequestType requestType,
 Artifact rootArtifact,
 PathScope scope)

build

@Nonnull
static DependencyResolverRequest build(Session session,
 DependencyResolverRequest.RequestType requestType,
 Project project)

build

@Nonnull
static DependencyResolverRequest build(Session session,
 DependencyResolverRequest.RequestType requestType,
 Project project,
 PathScope scope)

build

@Nonnull
static DependencyResolverRequest build(Session session,
 DependencyResolverRequest.RequestType requestType,
 DependencyCoordinates dependency)

build

@Nonnull
static DependencyResolverRequest build(Session session,
 DependencyResolverRequest.RequestType requestType,
 DependencyCoordinates dependency,
 PathScope scope)

build

@Nonnull
static DependencyResolverRequest build(Session session,
 DependencyResolverRequest.RequestType requestType,
 List<DependencyCoordinates> dependencies)

build

@Nonnull
static DependencyResolverRequest build(Session session,
 DependencyResolverRequest.RequestType requestType,
 List<DependencyCoordinates> dependencies,
 PathScope scope)