Package org.apache.maven.report.projectinfo.dependencies

Class Dependencies

java.lang.Object

org.apache.maven.report.projectinfo.dependencies.Dependencies

public class Dependencies
extends java.lang.Object

Since:

2.1

Constructor Summary

Constructors

Constructor	Description
Dependencies(MavenProject project, DependencyNode dependencyTreeNode, JarClassesAnalysis classesAnalyzer)	Default constructor

Method Summary

Modifier and Type	Method	Description
java.util.List<Artifact>	getAllDependencies()
java.util.Map<java.lang.String,java.util.List<Artifact>>	getDependenciesByScope(boolean isTransitively)
java.io.File	getFile(Artifact artifact)	get the artifact's file, with detection of target/classes directory with already packaged jar available.
JarData	getJarDependencyDetails(Artifact artifact)
MavenProject	getProject()	Getter for the project
java.util.List<Artifact>	getProjectDependencies()
java.util.List<Artifact>	getTransitiveDependencies()
boolean	hasDependencies()

Methods inherited from class java.lang.Object

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

Constructor Detail

Dependencies

public Dependencies(MavenProject project,
                    DependencyNode dependencyTreeNode,
                    JarClassesAnalysis classesAnalyzer)

Default constructor

Parameters:

project - the MavenProject.

dependencyTreeNode - the DependencyNode.

classesAnalyzer - the JarClassesAnalysis.

Method Detail

getProject

public MavenProject getProject()

Getter for the project

Returns:

the project

hasDependencies

public boolean hasDependencies()

Returns:

true if getProjectDependencies() is not empty, false otherwise.

getProjectDependencies

public java.util.List<Artifact> getProjectDependencies()

Returns:

a list of Artifact from the project.

getTransitiveDependencies

public java.util.List<Artifact> getTransitiveDependencies()

Returns:

a list of transitive Artifact from the project.

getAllDependencies

public java.util.List<Artifact> getAllDependencies()

Returns:

a list of included Artifact returned by the dependency tree.

getDependenciesByScope

public java.util.Map<java.lang.String,java.util.List<Artifact>> getDependenciesByScope(boolean isTransitively)

Parameters:

isTransitively - true to return transitive dependencies, false otherwise.

Returns:

a map with supported scopes as key and a list of Artifact as values.

See Also:

Artifact.SCOPE_COMPILE, Artifact.SCOPE_PROVIDED, Artifact.SCOPE_RUNTIME, Artifact.SCOPE_SYSTEM, Artifact.SCOPE_TEST

getJarDependencyDetails

public JarData getJarDependencyDetails(Artifact artifact)
                                throws java.io.IOException

Parameters:

artifact - the artifact.

Returns:

the jardata object from the artifact

Throws:

java.io.IOException - if any

getFile

public java.io.File getFile(Artifact artifact)

get the artifact's file, with detection of target/classes directory with already packaged jar available.

Parameters:

artifact - the artifact to retrieve the physical file

Returns:

the physical file representing the given artifact