Class ProjectDependencyAnalysis
- java.lang.Object
-
- org.apache.maven.shared.dependency.analyzer.ProjectDependencyAnalysis
-
public class ProjectDependencyAnalysis extends java.lang.Object
Project dependencies analysis result.- Author:
- Mark Hobson
-
-
Constructor Summary
Constructors Constructor Description ProjectDependencyAnalysis()
Constructor for ProjectDependencyAnalysis.ProjectDependencyAnalysis(java.util.Map<org.apache.maven.artifact.Artifact,java.util.Set<DependencyUsage>> usedDeclaredArtifacts, java.util.Map<org.apache.maven.artifact.Artifact,java.util.Set<DependencyUsage>> usedUndeclaredArtifacts, java.util.Set<org.apache.maven.artifact.Artifact> unusedDeclaredArtifacts, java.util.Set<org.apache.maven.artifact.Artifact> testArtifactsWithNonTestScope)
ProjectDependencyAnalysis(java.util.Set<org.apache.maven.artifact.Artifact> usedDeclaredArtifacts, java.util.Set<org.apache.maven.artifact.Artifact> usedUndeclaredArtifacts, java.util.Set<org.apache.maven.artifact.Artifact> unusedDeclaredArtifacts)
Constructor for ProjectDependencyAnalysis to maintain compatibility with old APIProjectDependencyAnalysis(java.util.Set<org.apache.maven.artifact.Artifact> usedDeclaredArtifacts, java.util.Set<org.apache.maven.artifact.Artifact> usedUndeclaredArtifacts, java.util.Set<org.apache.maven.artifact.Artifact> unusedDeclaredArtifacts, java.util.Set<org.apache.maven.artifact.Artifact> testArtifactsWithNonTestScope)
Constructor for ProjectDependencyAnalysis.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object object)
ProjectDependencyAnalysis
forceDeclaredDependenciesUsage(java.lang.String[] forceUsedDependencies)
Force use status of some declared dependencies, to manually fix consequences of bytecode-level analysis which happens to not detect some effective use (constants, annotation with source-retention, javadoc).java.util.Set<org.apache.maven.artifact.Artifact>
getTestArtifactsWithNonTestScope()
Returns artifacts only used in tests but not declared with test scope.java.util.Set<org.apache.maven.artifact.Artifact>
getUnusedDeclaredArtifacts()
Returns artifacts declared but not used.java.util.Set<org.apache.maven.artifact.Artifact>
getUsedDeclaredArtifacts()
Returns artifacts both used and declared.java.util.Map<org.apache.maven.artifact.Artifact,java.util.Set<DependencyUsage>>
getUsedDeclaredArtifactsWithUsages()
Returns artifacts both used and declared.java.util.Set<org.apache.maven.artifact.Artifact>
getUsedUndeclaredArtifacts()
Returns artifacts used but not declared.java.util.Map<org.apache.maven.artifact.Artifact,java.util.Set<java.lang.String>>
getUsedUndeclaredArtifactsWithClasses()
Returns artifacts used but not declared.java.util.Map<org.apache.maven.artifact.Artifact,java.util.Set<DependencyUsage>>
getUsedUndeclaredArtifactsWithUsages()
int
hashCode()
hashCode.ProjectDependencyAnalysis
ignoreNonCompile()
Filter non-compile scoped artifacts from unused declared.java.lang.String
toString()
toString.
-
-
-
Constructor Detail
-
ProjectDependencyAnalysis
public ProjectDependencyAnalysis()
Constructor for ProjectDependencyAnalysis.
-
ProjectDependencyAnalysis
public ProjectDependencyAnalysis(java.util.Set<org.apache.maven.artifact.Artifact> usedDeclaredArtifacts, java.util.Set<org.apache.maven.artifact.Artifact> usedUndeclaredArtifacts, java.util.Set<org.apache.maven.artifact.Artifact> unusedDeclaredArtifacts)
Constructor for ProjectDependencyAnalysis to maintain compatibility with old API
- Parameters:
usedDeclaredArtifacts
- artifacts both used and declaredusedUndeclaredArtifacts
- artifacts used but not declaredunusedDeclaredArtifacts
- artifacts declared but not used
-
ProjectDependencyAnalysis
public ProjectDependencyAnalysis(java.util.Set<org.apache.maven.artifact.Artifact> usedDeclaredArtifacts, java.util.Set<org.apache.maven.artifact.Artifact> usedUndeclaredArtifacts, java.util.Set<org.apache.maven.artifact.Artifact> unusedDeclaredArtifacts, java.util.Set<org.apache.maven.artifact.Artifact> testArtifactsWithNonTestScope)
Constructor for ProjectDependencyAnalysis.
- Parameters:
usedDeclaredArtifacts
- artifacts both used and declaredusedUndeclaredArtifacts
- artifacts used but not declaredunusedDeclaredArtifacts
- artifacts declared but not usedtestArtifactsWithNonTestScope
- artifacts only used in tests but not declared with test scope
-
ProjectDependencyAnalysis
public ProjectDependencyAnalysis(java.util.Map<org.apache.maven.artifact.Artifact,java.util.Set<DependencyUsage>> usedDeclaredArtifacts, java.util.Map<org.apache.maven.artifact.Artifact,java.util.Set<DependencyUsage>> usedUndeclaredArtifacts, java.util.Set<org.apache.maven.artifact.Artifact> unusedDeclaredArtifacts, java.util.Set<org.apache.maven.artifact.Artifact> testArtifactsWithNonTestScope)
-
-
Method Detail
-
getUsedDeclaredArtifacts
public java.util.Set<org.apache.maven.artifact.Artifact> getUsedDeclaredArtifacts()
Returns artifacts both used and declared.- Returns:
- artifacts both used and declared
-
getUsedDeclaredArtifactsWithUsages
public java.util.Map<org.apache.maven.artifact.Artifact,java.util.Set<DependencyUsage>> getUsedDeclaredArtifactsWithUsages()
Returns artifacts both used and declared.- Returns:
- artifacts both used and declared
-
getUsedUndeclaredArtifacts
public java.util.Set<org.apache.maven.artifact.Artifact> getUsedUndeclaredArtifacts()
Returns artifacts used but not declared.- Returns:
- artifacts used but not declared
-
getUsedUndeclaredArtifactsWithClasses
public java.util.Map<org.apache.maven.artifact.Artifact,java.util.Set<java.lang.String>> getUsedUndeclaredArtifactsWithClasses()
Returns artifacts used but not declared.- Returns:
- artifacts used but not declared
-
getUsedUndeclaredArtifactsWithUsages
public java.util.Map<org.apache.maven.artifact.Artifact,java.util.Set<DependencyUsage>> getUsedUndeclaredArtifactsWithUsages()
-
getUnusedDeclaredArtifacts
public java.util.Set<org.apache.maven.artifact.Artifact> getUnusedDeclaredArtifacts()
Returns artifacts declared but not used.- Returns:
- artifacts declared but not used
-
getTestArtifactsWithNonTestScope
public java.util.Set<org.apache.maven.artifact.Artifact> getTestArtifactsWithNonTestScope()
Returns artifacts only used in tests but not declared with test scope.- Returns:
- artifacts only used in tests but not declared with test scope
-
ignoreNonCompile
public ProjectDependencyAnalysis ignoreNonCompile()
Filter non-compile scoped artifacts from unused declared.- Returns:
- updated project dependency analysis
- Since:
- 1.3
-
forceDeclaredDependenciesUsage
public ProjectDependencyAnalysis forceDeclaredDependenciesUsage(java.lang.String[] forceUsedDependencies) throws ProjectDependencyAnalyzerException
Force use status of some declared dependencies, to manually fix consequences of bytecode-level analysis which happens to not detect some effective use (constants, annotation with source-retention, javadoc).- Parameters:
forceUsedDependencies
- dependencies to move from "unused-declared" to "used-declared", withgroupId:artifactId
format- Returns:
- updated project dependency analysis
- Throws:
ProjectDependencyAnalyzerException
- if dependencies forced were either not declared or already detected as used- Since:
- 1.3
-
hashCode
public int hashCode()
hashCode.
- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- an int
-
equals
public boolean equals(java.lang.Object object)
- Overrides:
equals
in classjava.lang.Object
-
toString
public java.lang.String toString()
toString.
- Overrides:
toString
in classjava.lang.Object
- Returns:
- a
String
object.
-
-