org.apache.maven.api.services

Class DependencyCollectorRequest.DependencyCollectorRequestBuilder

java.lang.Object

org.apache.maven.api.services.DependencyCollectorRequest.DependencyCollectorRequestBuilder

Enclosing interface:

DependencyCollectorRequest

@NotThreadSafe
public static class DependencyCollectorRequest.DependencyCollectorRequestBuilder
extends Object

Method Summary

Modifier and Type	Method and Description
DependencyCollectorRequest	build()
DependencyCollectorRequest.DependencyCollectorRequestBuilder	dependencies(List<DependencyCoordinate> dependencies) Sets the direct dependencies.
DependencyCollectorRequest.DependencyCollectorRequestBuilder	dependency(DependencyCoordinate dependency) Adds the specified direct dependency.
DependencyCollectorRequest.DependencyCollectorRequestBuilder	managedDependencies(List<DependencyCoordinate> managedDependencies) Sets the dependency management to apply to transitive dependencies.
DependencyCollectorRequest.DependencyCollectorRequestBuilder	managedDependency(DependencyCoordinate managedDependency) Adds the specified managed dependency.
DependencyCollectorRequest.DependencyCollectorRequestBuilder	root(DependencyCoordinate root)
DependencyCollectorRequest.DependencyCollectorRequestBuilder	rootArtifact(Artifact rootArtifact) Sets the root artifact for the dependency graph.
DependencyCollectorRequest.DependencyCollectorRequestBuilder	session(Session session)
DependencyCollectorRequest.DependencyCollectorRequestBuilder	verbose(boolean verbose) Specifies that the collection should be verbose.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

session

@Nonnull
public DependencyCollectorRequest.DependencyCollectorRequestBuilder session(@Nonnull
                                                                                     Session session)

rootArtifact

@Nonnull
public DependencyCollectorRequest.DependencyCollectorRequestBuilder rootArtifact(@Nullable
                                                                                          Artifact rootArtifact)

Sets the root artifact for the dependency graph. This must not be confused with root(DependencyCoordinate): The root dependency, like any other specified dependency, will be subject to dependency collection/resolution, i.e. should have an artifact descriptor and a corresponding artifact file. The root artifact on the other hand is only used as a label for the root node of the graph in case no root dependency was specified. As such, the configured root artifact is ignored if root(DependencyCoordinate) has been set.

Parameters:

rootArtifact - The root artifact for the dependency graph, may be null.

Returns:

This request for chaining, never null.

root

@Nonnull
public DependencyCollectorRequest.DependencyCollectorRequestBuilder root(@Nonnull
                                                                                  DependencyCoordinate root)

Parameters:

root - The root dependency

Returns:

This request for chaining, never null.

dependencies

@Nonnull
public DependencyCollectorRequest.DependencyCollectorRequestBuilder dependencies(@Nullable
                                                                                          List<DependencyCoordinate> dependencies)

Sets the direct dependencies. If both a root dependency and direct dependencies are given in the request, the direct dependencies from the request will be merged with the direct dependencies from the root dependency's artifact descriptor, giving higher priority to the dependencies from the request.

Parameters:

dependencies - The direct dependencies, may be null.

Returns:

This request for chaining, never null.

dependency

@Nonnull
public DependencyCollectorRequest.DependencyCollectorRequestBuilder dependency(@Nullable
                                                                                        DependencyCoordinate dependency)

Adds the specified direct dependency.

Parameters:

dependency - The dependency to add, may be null.

Returns:

This request for chaining, never null.

managedDependencies

@Nonnull
public DependencyCollectorRequest.DependencyCollectorRequestBuilder managedDependencies(@Nullable
                                                                                                 List<DependencyCoordinate> managedDependencies)

Sets the dependency management to apply to transitive dependencies. To clarify, this management does not apply to the direct dependencies of the root node.

Parameters:

managedDependencies - The dependency management, may be null.

Returns:

This request for chaining, never null.

managedDependency

@Nonnull
public DependencyCollectorRequest.DependencyCollectorRequestBuilder managedDependency(@Nullable
                                                                                               DependencyCoordinate managedDependency)

Adds the specified managed dependency.

Parameters:

managedDependency - The managed dependency to add, may be null in which case the call will have no effect.

Returns:

This request for chaining, never null.

verbose

@Nonnull
public DependencyCollectorRequest.DependencyCollectorRequestBuilder verbose(boolean verbose)

Specifies that the collection should be verbose.

Parameters:

verbose - whether the collection should be verbose or not.

Returns:

This request for chaining, never null.

build

@Nonnull
public DependencyCollectorRequest build()