Class ProjectDependencyAnalysis


  • public class ProjectDependencyAnalysis
    extends java.lang.Object
    Project dependencies analysis result.
    Version:
    $Id$
    • Constructor Summary

      Constructors 
      Constructor Description
      ProjectDependencyAnalysis()  
      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)  
      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)  
    • Field Detail

      • usedDeclaredArtifacts

        private final java.util.Set<org.apache.maven.artifact.Artifact> usedDeclaredArtifacts
      • usedUndeclaredArtifacts

        private final java.util.Set<org.apache.maven.artifact.Artifact> usedUndeclaredArtifacts
      • unusedDeclaredArtifacts

        private final java.util.Set<org.apache.maven.artifact.Artifact> unusedDeclaredArtifacts
      • testArtifactsWithNonTestScope

        private final java.util.Set<org.apache.maven.artifact.Artifact> testArtifactsWithNonTestScope
    • Constructor Detail

      • ProjectDependencyAnalysis

        public 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)
      • 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)
    • Method Detail

      • getUsedDeclaredArtifacts

        public java.util.Set<org.apache.maven.artifact.Artifact> getUsedDeclaredArtifacts()
        Used and declared artifacts.
        Returns:
        Artifact
      • getUsedUndeclaredArtifacts

        public java.util.Set<org.apache.maven.artifact.Artifact> getUsedUndeclaredArtifacts()
        Used but not declared artifacts.
        Returns:
        Artifact
      • getUnusedDeclaredArtifacts

        public java.util.Set<org.apache.maven.artifact.Artifact> getUnusedDeclaredArtifacts()
        Unused but declared artifacts.
        Returns:
        Artifact
      • getTestArtifactsWithNonTestScope

        public java.util.Set<org.apache.maven.artifact.Artifact> getTestArtifactsWithNonTestScope()
        Test Artifacts that have a non-test scope
        Returns:
        Artifact
      • ignoreNonCompile

        public ProjectDependencyAnalysis ignoreNonCompile()
        Filter not-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", with groupId: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()
        Overrides:
        hashCode in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object object)
        Overrides:
        equals in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • safeCopy

        private java.util.Set<org.apache.maven.artifact.Artifact> safeCopy​(java.util.Set<org.apache.maven.artifact.Artifact> set)