org.jdepend.action

Class DependencyChecker

java.lang.Object

org.jdepend.action.DependencyChecker

Direct Known Subclasses:

SwingDependencyChecker

public class DependencyChecker
extends java.lang.Object

The DependencyChecker class checks dependencies between one list of jar files or class files directories and a set of packages.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	errors The map of errors.
protected boolean	isStrictCheck True if the check is strict.

Constructor Summary

Constructors

Constructor and Description
DependencyChecker()

Method Summary

Modifier and Type	Method and Description
boolean	check(java.io.File[] files, java.util.Set<java.lang.String> packages) Return true if there are no dependencies between an array of class files directories or jar files, and a Set of packages paths.
boolean	check(java.io.File[] files, java.util.Set<java.lang.String> packages, boolean strict) Return true if there are no dependencies between an array of class files directories or jar files, and a Set of packages paths.
boolean	check(java.io.File file, java.util.Set<java.lang.String> packages) Return true if there are no dependencies between a class files directory or jar file, and a Set of packages paths.
boolean	check(java.io.File file, java.util.Set<java.lang.String> packages, boolean strict) Return true if there are no dependencies between a class files directory or jar file, and a Set of packages paths.
boolean	check(JarDependencies depend, java.util.Set<java.lang.String> packages) Return true if there are no dependencies between a JarDependency, and a Set of packages paths.
boolean	check(JarDependencies depend, java.util.Set<java.lang.String> packages, boolean strict) Return true if there are no dependencies between a JarDependency, and a Set of packages paths.
boolean	check(java.util.List<java.io.File> files, java.util.Set<java.lang.String> packages) Return true if there are no dependencies between a List of class files directories or jar files, and a Set of packages paths.
boolean	check(java.util.List<java.io.File> files, java.util.Set<java.lang.String> packages, boolean strict) Return true if there are no dependencies between a List of class files directories or jar files, and a Set of packages paths.
boolean	checkPackages(java.io.File[] files, java.util.Set<PackagePath> packages) Return true if there are no dependencies between an array of class files directories or jar files, and a Set of packages paths.
boolean	checkPackages(java.io.File[] files, java.util.Set<PackagePath> packages, boolean strict) Return true if there are no dependencies between an array of class files directories or jar files, and a Set of packages paths.
boolean	checkPackages(JarDependencies depend, java.util.Set<PackagePath> packages) Return true if there are no dependencies between a JarDependency, and a Set of packages paths.
boolean	checkPackages(JarDependencies depend, java.util.Set<PackagePath> packages, boolean strict) Return true if there are no dependencies between a JarDependency, and a Set of packages paths.
boolean	checkPackages(java.util.List<java.io.File> files, java.util.Set<PackagePath> packages, boolean strict) Return true if there are no dependencies between a List of class files directories or jar files, and a Set of packages paths.
java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	getDependencies() Return the Map of dependencies found during the checking.
java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	getDependencies(java.util.List<java.io.File> files, java.util.Set<java.lang.String> packages) Return the dependencies between a List of class files directories or jar files, and a Set of packages paths.
java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	getDependencies(java.util.List<java.io.File> files, java.util.Set<java.lang.String> packages, boolean strict) Return the dependencies between a List of class files directories or jar files, and a Set of packages paths.
java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	getJarDependencies(JarDependencies depend, java.util.Set<java.lang.String> packages) Return the dependencies between a JarDependency, and a Set of packages paths.
java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	getJarDependencies(JarDependencies depend, java.util.Set<java.lang.String> packages, boolean strict) Return the dependencies between a JarDependency, and a Set of packages paths.
protected boolean	performCheck() Perform the check.

Methods inherited from class java.lang.Object

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

Field Detail

errors

protected final java.util.Map<java.lang.String,java.util.Set<java.lang.String>> errors

The map of errors.

isStrictCheck

protected boolean isStrictCheck

True if the check is strict.

Constructor Detail

DependencyChecker

public DependencyChecker()

Method Detail

performCheck

protected boolean performCheck()
                        throws java.io.IOException

Perform the check.

Returns:

true if the check was successful.

Throws:

java.io.IOException

check

public boolean check(java.util.List<java.io.File> files,
                     java.util.Set<java.lang.String> packages)
              throws java.io.IOException

Return true if there are no dependencies between a List of class files directories or jar files, and a Set of packages paths.

Parameters:

files - the List of class files directories or jar files

packages - the Set of packages path

Returns:

true if there are no dependencies between the List of class files directories or jar files, and the Set of packages paths

Throws:

java.io.IOException - if one of the Jar files does not exist or is unreadable, or is not a Jar file

check

public boolean check(java.util.List<java.io.File> files,
                     java.util.Set<java.lang.String> packages,
                     boolean strict)
              throws java.io.IOException

Return true if there are no dependencies between a List of class files directories or jar files, and a Set of packages paths.

Parameters:

files - the List of class files directories or jar files

packages - the Set of packages path

strict - if the check is strict

Returns:

true if there are no dependencies between the List of class files directories or jar files, and the Set of packages paths

Throws:

java.io.IOException - if one of the Jar files does not exist or is unreadable, or is not a Jar file

checkPackages

public boolean checkPackages(java.util.List<java.io.File> files,
                             java.util.Set<PackagePath> packages,
                             boolean strict)
                      throws java.io.IOException

Return true if there are no dependencies between a List of class files directories or jar files, and a Set of packages paths.

Parameters:

files - the List of class files directories or jar files

packages - the Set of packages path

strict - if the check is strict

Returns:

true if there are no dependencies between the List of class files directories or jar files, and the Set of packages paths

Throws:

java.io.IOException - if one of the Jar files does not exist or is unreadable, or is not a Jar file

getDependencies

public java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getDependencies(java.util.List<java.io.File> files,
                                                                                       java.util.Set<java.lang.String> packages)
                                                                                throws java.io.IOException

Return the dependencies between a List of class files directories or jar files, and a Set of packages paths.

Parameters:

files - the List of class files directories or jar files

packages - the Set of packages path

Returns:

true if there are no dependencies between the List of class files directories or jar files, and the Set of packages paths

Throws:

java.io.IOException - if one of the Jar files does not exist or is unreadable, or is not a Jar file

getDependencies

public java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getDependencies(java.util.List<java.io.File> files,
                                                                                       java.util.Set<java.lang.String> packages,
                                                                                       boolean strict)
                                                                                throws java.io.IOException

Return the dependencies between a List of class files directories or jar files, and a Set of packages paths.

Parameters:

files - the List of class files directories or jar files

packages - the Set of package

strict - if the check is strict

Returns:

true if there are no dependencies between the List of class files directories or jar files, and the Set of packages paths

Throws:

java.io.IOException - if one of the Jar files does not exist or is unreadable, or is not a Jar file

checkPackages

public boolean checkPackages(JarDependencies depend,
                             java.util.Set<PackagePath> packages)
                      throws java.io.IOException

Return true if there are no dependencies between a JarDependency, and a Set of packages paths.

Parameters:

depend - the JarDependencies

packages - the Set of packages path

Returns:

true if there are no dependencies between the List of class files directories or jar files, and the Set of packages paths

Throws:

java.io.IOException - if the Jar file does not exist or is unreadable, or is not a Jar file

check

public boolean check(JarDependencies depend,
                     java.util.Set<java.lang.String> packages)
              throws java.io.IOException

Return true if there are no dependencies between a JarDependency, and a Set of packages paths.

Parameters:

depend - the JarDependencies

packages - the Set of packages path

Returns:

true if there are no dependencies between the List of class files directories or jar files, and the Set of packages paths

Throws:

java.io.IOException - if the Jar file does not exist or is unreadable, or is not a Jar file

check

public boolean check(JarDependencies depend,
                     java.util.Set<java.lang.String> packages,
                     boolean strict)
              throws java.io.IOException

Return true if there are no dependencies between a JarDependency, and a Set of packages paths.

Parameters:

depend - the JarDependencies

packages - the Set of packages path

strict - if the check is strict

Returns:

true if there are no dependencies between the List of class files directories or jar files, and the Set of packages paths

Throws:

java.io.IOException - if the Jar file does not exist or is unreadable, or is not a Jar file

checkPackages

public boolean checkPackages(JarDependencies depend,
                             java.util.Set<PackagePath> packages,
                             boolean strict)
                      throws java.io.IOException

Return true if there are no dependencies between a JarDependency, and a Set of packages paths.

Parameters:

depend - the JarDependencies

packages - the Set of packages path

strict - if the check is strict

Returns:

true if there are no dependencies between the List of class files directories or jar files, and the Set of packages paths

Throws:

java.io.IOException - if the Jar file does not exist or is unreadable, or is not a Jar file

getJarDependencies

public java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getJarDependencies(JarDependencies depend,
                                                                                          java.util.Set<java.lang.String> packages)
                                                                                   throws java.io.IOException

Return the dependencies between a JarDependency, and a Set of packages paths.

Parameters:

depend - the JarDependencies

packages - the Set of packages path

Returns:

true if there are no dependencies between the List of class files directories or jar files, and the Set of packages paths

Throws:

java.io.IOException - if the Jar file does not exist or is unreadable, or is not a Jar file

getJarDependencies

public java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getJarDependencies(JarDependencies depend,
                                                                                          java.util.Set<java.lang.String> packages,
                                                                                          boolean strict)
                                                                                   throws java.io.IOException

Return the dependencies between a JarDependency, and a Set of packages paths.

Parameters:

depend - the JarDependencies

packages - the Set of packages path

strict - if the check is strict

Returns:

true if there are no dependencies between the List of class files directories or jar files, and the Set of packages paths

Throws:

java.io.IOException - if the Jar file does not exist or is unreadable, or is not a Jar file

check

public boolean check(java.io.File file,
                     java.util.Set<java.lang.String> packages)
              throws java.io.IOException

Return true if there are no dependencies between a class files directory or jar file, and a Set of packages paths.

Parameters:

file - the class files directory or jar files

packages - the Set of packages path

Returns:

true if there are no dependencies between the array of class files directories or jar files, and the Set of packages paths

Throws:

java.io.IOException - if one of the Jar files does not exist or is unreadable, or is not a Jar file

check

public boolean check(java.io.File file,
                     java.util.Set<java.lang.String> packages,
                     boolean strict)
              throws java.io.IOException

Return true if there are no dependencies between a class files directory or jar file, and a Set of packages paths.

Parameters:

file - the class files directory or jar files

packages - the Set of packages path

strict - if the check is strict

Returns:

true if there are no dependencies between the array of class files directories or jar files, and the Set of packages paths

Throws:

java.io.IOException - if one of the Jar files does not exist or is unreadable, or is not a Jar file

check

public boolean check(java.io.File[] files,
                     java.util.Set<java.lang.String> packages)
              throws java.io.IOException

Return true if there are no dependencies between an array of class files directories or jar files, and a Set of packages paths.

Parameters:

files - the array of class files directories or jar files

packages - the Set of packages path

Returns:

true if there are no dependencies between the array of class files directories or jar files, and the Set of packages paths

Throws:

java.io.IOException - if one of the Jar files does not exist or is unreadable, or is not a Jar file

checkPackages

public boolean checkPackages(java.io.File[] files,
                             java.util.Set<PackagePath> packages)
                      throws java.io.IOException

Return true if there are no dependencies between an array of class files directories or jar files, and a Set of packages paths.

Parameters:

files - the array of class files directories or jar files

packages - the Set of packages path

Returns:

true if there are no dependencies between the array of class files directories or jar files, and the Set of packages paths

Throws:

java.io.IOException - if one of the Jar files does not exist or is unreadable, or is not a Jar file

check

public boolean check(java.io.File[] files,
                     java.util.Set<java.lang.String> packages,
                     boolean strict)
              throws java.io.IOException

Return true if there are no dependencies between an array of class files directories or jar files, and a Set of packages paths.

Parameters:

files - the array of class files directories or jar files

packages - the Set of packages path

strict - if the check is strict

Returns:

true if there are no dependencies between the array of class files directories or jar files, and the Set of packages paths

Throws:

java.io.IOException - if one of the Jar files does not exist or is unreadable, or is not a Jar file

checkPackages

public boolean checkPackages(java.io.File[] files,
                             java.util.Set<PackagePath> packages,
                             boolean strict)
                      throws java.io.IOException

Return true if there are no dependencies between an array of class files directories or jar files, and a Set of packages paths.

Parameters:

files - the array of class files directories or jar files

packages - the Set of packages path

strict - if the check is strict

Returns:

true if there are no dependencies between the array of class files directories or jar files, and the Set of packages paths

Throws:

java.io.IOException - if one of the Jar files does not exist or is unreadable, or is not a Jar file

getDependencies

public java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getDependencies()

Return the Map of dependencies found during the checking. The Map will be empty if there are no dependencies between the list of jar files or class files directories and a set of packages. The keys of the Map are the classes in the list of jar files or class files directories which have a dependency on the Set of packages. The values are the classpath of the classes which they depend on.

Returns:

the Map of dependencies found during the checking