org.jdepend.model

Class JarDependencies

java.lang.Object

org.jdepend.model.JarDependencies

public class JarDependencies
extends java.lang.Object

This class models a jar file or a class files directory. It can be used in several actions in the JDependency application. A JarDependencies contains:

• The list of paths found in this jar file or class files directory
• The list of dependencies

Usage

The simplest way to use this class is simply to create one JarDependencies and provide it a directory containing classes, or one jar file.

   JarDependencies depend = new JarDependencies(myJarFile);
 

It is then possible to use it in the application. One simple thing to do is checking if the JarDependencies has dependencies from another one. For example:

   JarDependencies depend = new JarDependencies(myJarFile);
   JarDependencies anotherDepend = new JarDependencies(aSecondJarFile);
   boolean isDependingOn = depend.isDependingOn(anotherDepend);
 

Constructor Summary

Constructors

Constructor and Description
JarDependencies() Create an initially empty JarDependencies.
JarDependencies(java.io.File file) Create a JarDependencies for a specified jar file or class files directory.
JarDependencies(java.io.File dir, java.lang.String rootname, boolean acceptUnversioned) Create a JarDependencies for a specified jar file or class files directory.
JarDependencies(java.io.File dir, java.lang.String rootname, boolean acceptUnversioned, short separatorType) Create a JarDependencies for a specified jar file or class files directory.

Method Summary

Modifier and Type	Method and Description
boolean	containsPath(java.lang.String path) Return true if this jar file or class files directory contains the specified path.
ClassDependencies	dependenciesFrom(JarDependencies dependencies) Return the dependencies from this JarDependencies on another JarDependencies.
ClassDependencies	dependenciesFrom(JarDependencies dependencies, java.util.Set<java.lang.String> excludedClasses) Return the dependencies from this JarDependencies on another JarDependencies.
ClassDependencies	dependenciesFrom(JarDependencies dependencies, java.lang.String packagePath) Return the dependencies from this JarDependencies on another JarDependencies.
ClassDependencies	dependenciesFrom(JarDependencies dependencies, java.lang.String packagePath, boolean isStrict) Return the dependencies from this JarDependencies on another JarDependencies.
java.util.Map<java.lang.String,java.lang.Integer>	getClassesAccess() Return the accessors for each class.
java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	getDependencies() Return all the dependencies for all classes defined in this jar file or class files directory.
java.util.Map<java.lang.String,ClassDependencies>	getDependencies(JarDependencies jarDepend) Return the dependencies of this JarDependencies from another JarDependencies.
java.util.Map<java.lang.String,ClassDependencies>	getDependencies(java.util.List<JarDependencies> jarList) Return the dependencies of this JarDependencies from a list of JarDependencies.
ClassDependencies	getDependenciesOn(java.lang.String pack, boolean isStrict) Return the internal dependencies in the JarDependencies on a specified package.
java.io.File	getFile() Return the jar file or class files directory.
java.util.jar.Manifest	getManifest() Return the Manifest if this represents a Jar file.
java.lang.String	getName() Return the name of the jar file or class files directory.
java.util.Set<java.lang.String>	getPackageNames() Return all the packages found in this jar file or class files directory.
java.util.Set<java.lang.String>	getPaths() Return all the paths found in this jar file or class files directory.
boolean	hasDefaultPackage() Return true if there are classes in the default package.
boolean	isDependingOn(JarDependencies dependencies) Return true if this jar file or class files directory depends on another jar file or class files directory.
boolean	isDependingOn(JarDependencies dependencies, java.util.Set<java.lang.String> excludingClasses) Return true if this jar file or class files directory depends on another jar file or class files directory.
boolean	isDependingOn(JarDependencies dependencies, java.lang.String packagePath) Return true if this jar file or class files directory depends on another jar file or class files directory.
boolean	isDependingOn(JarDependencies dependencies, java.lang.String packagePath, boolean isStrict) Return true if this jar file or class files directory depends on another jar file or class files directory.
boolean	isDependingOn(java.util.Set<java.lang.String> packages) Return true if this JarDependencies depend on a list of packages or classes.
boolean	isDependingOn(java.lang.String pack) Return true if this JarDependencies depend on one package.
boolean	isJarFile() Return true if this represents a Jar file.
void	setFile(java.io.File file) Set the jar file or class files directory.
void	setFile(java.io.File dir, java.lang.String rootname, boolean acceptUnversioned) Set the jar file directory using a file name pattern, using the fdash the separate the pattern elements.
void	setFile(java.io.File dir, java.lang.String rootname, boolean acceptUnversioned, short separatorType) Set the jar file directory using a file name pattern.

Methods inherited from class java.lang.Object

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

Constructor Detail

JarDependencies

public JarDependencies()

Create an initially empty JarDependencies.

JarDependencies

public JarDependencies(java.io.File dir,
                       java.lang.String rootname,
                       boolean acceptUnversioned)
                throws java.io.IOException

Create a JarDependencies for a specified jar file or class files directory.

Parameters:

dir - the directory where to look for the jar file

rootname - the root name of the jar file

acceptUnversioned - true if unversioned jar files must be allowed

Throws:

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

JarDependencies

public JarDependencies(java.io.File dir,
                       java.lang.String rootname,
                       boolean acceptUnversioned,
                       short separatorType)
                throws java.io.IOException

Create a JarDependencies for a specified jar file or class files directory.

Parameters:

dir - the directory where to look for the jar file

rootname - the root name of the jar file

acceptUnversioned - true if unversioned jar files must be allowed

separatorType - the separator which is used to separate the pattern elements. See NamePatternSeparator

Throws:

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

JarDependencies

public JarDependencies(java.io.File file)
                throws java.io.IOException

Create a JarDependencies for a specified jar file or class files directory.

Parameters:

file - the jar file

Throws:

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

Method Detail

setFile

public final void setFile(java.io.File file)
                   throws java.io.IOException

Set the jar file or class files directory.

Parameters:

file - the jar file or class files directory

Throws:

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

setFile

public final void setFile(java.io.File dir,
                          java.lang.String rootname,
                          boolean acceptUnversioned,
                          short separatorType)
                   throws java.io.IOException

Set the jar file directory using a file name pattern.

Parameters:

dir - the directory where to look for the jar file

rootname - the root name of the jar file

acceptUnversioned - true if unversioned jar files must be allowed

separatorType - the separator type

Throws:

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

setFile

public final void setFile(java.io.File dir,
                          java.lang.String rootname,
                          boolean acceptUnversioned)
                   throws java.io.IOException

Set the jar file directory using a file name pattern, using the fdash the separate the pattern elements.

Parameters:

dir - the directory where to look for the jar file

rootname - the root name of the jar file

acceptUnversioned - true if unversioned jar files must be allowed

Throws:

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

getName

public java.lang.String getName()

Return the name of the jar file or class files directory.

Returns:

the name of the jar file or class files directory

getFile

public java.io.File getFile()

Return the jar file or class files directory.

Returns:

the jar file or class files directory

getDependencies

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

Return all the dependencies for all classes defined in this jar file or class files directory. The Map keys are the class paths in this jar file or class files directory, the values are all the class paths on which each class depend on.

Example

Suppose that the class files directory or jar file only contains one class with the following path org.mypackage.MyPanel:

 import javax.swing.JPanel

 public class MyPanel extends JPanel() {
   public MyPanel() {
     super();
   }
 }
 

In this case there is only one class org.mypackage.MyPanel, and this class has only one dependency: javax.swing.JPanel. The method will return a Map with only one element.

Returns:

all the dependencies for all classes defined in this jar file or class files directory

getClassesAccess

public java.util.Map<java.lang.String,java.lang.Integer> getClassesAccess()

Return the accessors for each class.

Returns:

the accessors for each class

getPackageNames

public java.util.Set<java.lang.String> getPackageNames()

Return all the packages found in this jar file or class files directory.

Returns:

all the packages found in this jar file or class files directory

hasDefaultPackage

public boolean hasDefaultPackage()

Return true if there are classes in the default package.

Returns:

true if there are classes in the default package

getPaths

public java.util.Set<java.lang.String> getPaths()

Return all the paths found in this jar file or class files directory.

Returns:

all the paths found in this jar file or class files directory

containsPath

public boolean containsPath(java.lang.String path)

Return true if this jar file or class files directory contains the specified path.

Parameters:

path - the path

Returns:

true if this jar file or class files directory contains the specified path

isJarFile

public boolean isJarFile()

Return true if this represents a Jar file.

Returns:

true if this represents a Jar file

getManifest

public java.util.jar.Manifest getManifest()

Return the Manifest if this represents a Jar file.

Returns:

the Manifest if this represents a Jar file

getDependenciesOn

public ClassDependencies getDependenciesOn(java.lang.String pack,
                                           boolean isStrict)

Return the internal dependencies in the JarDependencies on a specified package.

Parameters:

pack - the package

isStrict - true if subpackages of the specified package will not be considered in the filter

Returns:

the internal dependencies in the JarDependencies on the specified package

getDependencies

public java.util.Map<java.lang.String,ClassDependencies> getDependencies(JarDependencies jarDepend)

Return the dependencies of this JarDependencies from another JarDependencies.

Parameters:

jarDepend - the other JarDependencies

Returns:

the dependencies of this JarDependencies from e other JarDependencies

getDependencies

public java.util.Map<java.lang.String,ClassDependencies> getDependencies(java.util.List<JarDependencies> jarList)

Return the dependencies of this JarDependencies from a list of JarDependencies.

Parameters:

jarList - the list of JarDependencies

Returns:

the dependencies of this JarDependencies from a list of JarDependencies

isDependingOn

public boolean isDependingOn(JarDependencies dependencies)

Return true if this jar file or class files directory depends on another jar file or class files directory.

Parameters:

dependencies - the jar file or class files directory which we seek to look if this jar file is depending on it

Returns:

true if this jar file or class files directory depends on another jar file or class files directory

isDependingOn

public boolean isDependingOn(JarDependencies dependencies,
                             java.util.Set<java.lang.String> excludingClasses)

Return true if this jar file or class files directory depends on another jar file or class files directory.

Parameters:

dependencies - the jar file or class files directory which we seek to look if this jar file is depending on it

excludingClasses - the classes to exclude from the check (can be null)

Returns:

true if this jar file or class files directory depends on another jar file or class files directory

isDependingOn

public boolean isDependingOn(JarDependencies dependencies,
                             java.lang.String packagePath)

Return true if this jar file or class files directory depends on another jar file or class files directory.

Parameters:

dependencies - the jar file or class files directory which we seek to look if this jar file is depending on it

packagePath - the package which we will use to filter the classes in the Jar to check

Returns:

true if this jar file or class files directory depends on another jar file or class files directory

isDependingOn

public boolean isDependingOn(JarDependencies dependencies,
                             java.lang.String packagePath,
                             boolean isStrict)

Return true if this jar file or class files directory depends on another jar file or class files directory.

Parameters:

dependencies - the jar file or class files directory which we seek to look if this jar file is depending on it

packagePath - the package which we will use to filter the classes in the Jar to check

isStrict - true if sub-packages of the specified package will not be considered in the filter

Returns:

true if this jar file or class files directory depends on another jar file or class files directory

isDependingOn

public boolean isDependingOn(java.lang.String pack)
                      throws java.io.IOException

Return true if this JarDependencies depend on one package.

Parameters:

pack - the package

Returns:

true if this JarDependencies depend on a package

Throws:

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

isDependingOn

public boolean isDependingOn(java.util.Set<java.lang.String> packages)
                      throws java.io.IOException

Return true if this JarDependencies depend on a list of packages or classes.

Parameters:

packages - the Set of packages

Returns:

true if this JarDependencies depend on a list of packages or classes

Throws:

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

dependenciesFrom

public ClassDependencies dependenciesFrom(JarDependencies dependencies)

Return the dependencies from this JarDependencies on another JarDependencies.

Parameters:

dependencies - the jar file or class files directory which we seek to look if this jar file is depending on it

Returns:

the dependencies from this JarDependencies on another JarDependencies

dependenciesFrom

public ClassDependencies dependenciesFrom(JarDependencies dependencies,
                                          java.util.Set<java.lang.String> excludedClasses)

Return the dependencies from this JarDependencies on another JarDependencies.

Parameters:

dependencies - the jar file or class files directory which we seek to look if this jar file is depending on it

excludedClasses - the classes to exclude fromm the check (can be null)

Returns:

the dependencies from this JarDependencies on another JarDependencies

dependenciesFrom

public ClassDependencies dependenciesFrom(JarDependencies dependencies,
                                          java.lang.String packagePath)

Return the dependencies from this JarDependencies on another JarDependencies.

Parameters:

dependencies - the jar file or class files directory which we seek to look if this jar file is depending on it

packagePath - the package where we look for dependencies

Returns:

the dependencies from this JarDependencies on another JarDependencies

dependenciesFrom

public ClassDependencies dependenciesFrom(JarDependencies dependencies,
                                          java.lang.String packagePath,
                                          boolean isStrict)

Return the dependencies from this JarDependencies on another JarDependencies.

Parameters:

dependencies - the jar file or class files directory which we seek to look if this jar file is depending on it

packagePath - the package where to look for dependencies

isStrict - true if subpackages of the specified package will not be considered in the filter

Returns:

the dependencies from this JarDependencies on another JarDependencies