Package org.apache.maven.api.services

Interface DependencyCollectorRequest

@Experimental
@Immutable
public interface DependencyCollectorRequest

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

See Also:

• DependencyCollector.collect(DependencyCollectorRequest)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	DependencyCollectorRequest.DependencyCollectorRequestBuilder

Method Summary

Modifier and Type	Method	Description
static DependencyCollectorRequest	build(Session session, Artifact root)
static DependencyCollectorRequest	build(Session session, DependencyCoordinate root)
static DependencyCollectorRequest	build(Session session, Project project)
static DependencyCollectorRequest.DependencyCollectorRequestBuilder	builder()
Collection<DependencyCoordinate>	getDependencies()
Collection<DependencyCoordinate>	getManagedDependencies()
Optional<DependencyCoordinate>	getRoot()
Optional<Artifact>	getRootArtifact()
Session	getSession()
boolean	getVerbose()

Method Details

getSession

@Nonnull
Session getSession()

getRootArtifact

@Nonnull
Optional<Artifact> getRootArtifact()

getRoot

@Nonnull
Optional<DependencyCoordinate> getRoot()

getDependencies

@Nonnull
Collection<DependencyCoordinate> getDependencies()

getManagedDependencies

@Nonnull
Collection<DependencyCoordinate> getManagedDependencies()

getVerbose

boolean getVerbose()

build

@Nonnull
static DependencyCollectorRequest build(@Nonnull
 Session session,
 Artifact root)

build

@Nonnull
static DependencyCollectorRequest build(@Nonnull
 Session session,
 @Nonnull
 DependencyCoordinate root)

build

@Nonnull
static DependencyCollectorRequest build(@Nonnull
 Session session,
 @Nonnull
 Project project)

builder

@Nonnull
static DependencyCollectorRequest.DependencyCollectorRequestBuilder builder()