Package org.apache.maven.shared.dependency.analyzer

Class ProjectDependencyAnalysis

java.lang.Object

org.apache.maven.shared.dependency.analyzer.ProjectDependencyAnalysis

public class ProjectDependencyAnalysis
extends Object

Project dependencies analysis result.

Version:

$Id$

Author:

Mark Hobson

Constructor Summary

Constructors

Constructor	Description
ProjectDependencyAnalysis()
ProjectDependencyAnalysis(Set<org.apache.maven.artifact.Artifact> usedDeclaredArtifacts, Set<org.apache.maven.artifact.Artifact> usedUndeclaredArtifacts, Set<org.apache.maven.artifact.Artifact> unusedDeclaredArtifacts)
ProjectDependencyAnalysis(Set<org.apache.maven.artifact.Artifact> usedDeclaredArtifacts, Set<org.apache.maven.artifact.Artifact> usedUndeclaredArtifacts, Set<org.apache.maven.artifact.Artifact> unusedDeclaredArtifacts, Set<org.apache.maven.artifact.Artifact> testArtifactsWithNonTestScope)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object object)
ProjectDependencyAnalysis	forceDeclaredDependenciesUsage(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).
Set<org.apache.maven.artifact.Artifact>	getTestArtifactsWithNonTestScope()	Test Artifacts that have a non-test scope
Set<org.apache.maven.artifact.Artifact>	getUnusedDeclaredArtifacts()	Unused but declared artifacts.
Set<org.apache.maven.artifact.Artifact>	getUsedDeclaredArtifacts()	Used and declared artifacts.
Set<org.apache.maven.artifact.Artifact>	getUsedUndeclaredArtifacts()	Used but not declared artifacts.
int	hashCode()
ProjectDependencyAnalysis	ignoreNonCompile()	Filter not-compile scoped artifacts from unused declared.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ProjectDependencyAnalysis

public ProjectDependencyAnalysis()

ProjectDependencyAnalysis

public ProjectDependencyAnalysis(Set<org.apache.maven.artifact.Artifact> usedDeclaredArtifacts,
                                 Set<org.apache.maven.artifact.Artifact> usedUndeclaredArtifacts,
                                 Set<org.apache.maven.artifact.Artifact> unusedDeclaredArtifacts)

ProjectDependencyAnalysis

public ProjectDependencyAnalysis(Set<org.apache.maven.artifact.Artifact> usedDeclaredArtifacts,
                                 Set<org.apache.maven.artifact.Artifact> usedUndeclaredArtifacts,
                                 Set<org.apache.maven.artifact.Artifact> unusedDeclaredArtifacts,
                                 Set<org.apache.maven.artifact.Artifact> testArtifactsWithNonTestScope)

Method Detail

getUsedDeclaredArtifacts

public Set<org.apache.maven.artifact.Artifact> getUsedDeclaredArtifacts()

Used and declared artifacts.

Returns:

Artifact

getUsedUndeclaredArtifacts

public Set<org.apache.maven.artifact.Artifact> getUsedUndeclaredArtifacts()

Used but not declared artifacts.

Returns:

Artifact

getUnusedDeclaredArtifacts

public Set<org.apache.maven.artifact.Artifact> getUnusedDeclaredArtifacts()

Unused but declared artifacts.

Returns:

Artifact

getTestArtifactsWithNonTestScope

public 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(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 Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object