org.jdepend.utils

Class JarManifestUtilities

java.lang.Object

org.jdepend.utils.JarManifestUtilities

public class JarManifestUtilities
extends java.lang.Object

This class allows to get the array or list of Class-Path dependencies of one jar file or a list of jar files. The dependencies are retrieved from the jar file Manifest Class-Path property. Note that:

• The class tries not to include twice the same jar file in the result
• The resulting URLs are all absolute. Relative dependencies will be correctly handled

For example, for the following jar file Manifest, for the following Jar file: L:/my/JarFile.jar:

 Class-Path: myJar1.jar \
             myJar2.jar
 

The getDependencies(java.net.URL) will return the following URLs:

• L:/my/myJar1.jar
• L:/my/myJar2.jar

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	ALLOW_UNUSED_EXPECTED_FILES True if files which are in the directories but not used in the ClassPath are allowed.
static boolean	PRINT_ERRORS True if errors must be printed on the console.

Method Summary

Modifier and Type	Method and Description
static boolean	checkDependencies(java.net.URL jarFile) Check that the dependencies present in a Class-Path manifest property do exist.
static boolean	checkDependencies(java.net.URL jarFile, boolean recursive) Check that the dependencies present in a Class-Path manifest property do exist.
static boolean	checkDependencies(java.net.URL jarFile, boolean recursive, java.util.List<java.net.URL> directories, java.util.Set<java.lang.String> excludedInputJars, java.util.Set<java.lang.String> excludedExpectedJars) Check that the dependencies present in a Class-Path manifest property do exist.
static boolean	checkDependencies(java.net.URL jarFile, boolean recursive, java.net.URL directory, java.util.Set<java.lang.String> excludedExpectedJars) Check that the dependencies present in a Class-Path manifest property do exist.
static boolean	checkDependencies(java.net.URL jarFile, boolean recursive, java.net.URL directory, java.util.Set<java.lang.String> excludedInputJars, java.util.Set<java.lang.String> excludedExpectedJars) Check that the dependencies present in a Class-Path manifest property do exist.
static boolean	checkDependencies(java.net.URL jarFile, java.util.List<java.net.URL> directories) Check that the dependencies present in a Class-Path manifest property do exist.
static boolean	checkDependencies(java.net.URL jarFile, java.util.List<java.net.URL> directories, java.util.Set<java.lang.String> excludedExpectedJars) Check that the dependencies present in a Class-Path manifest property do exist.
static boolean	checkDependencies(java.net.URL jarFile, java.net.URL directory, java.util.Set<java.lang.String> excludedExpectedJars) Check that the dependencies present in a Class-Path manifest property do exist.
static boolean	checkDependenciesFromFiles(java.io.File jarFile, boolean recursive, java.io.File directory) Check that the dependencies present in a Class-Path manifest property do exist.Getting the Class-Path property will not be recursive.
static boolean	checkDependenciesFromFiles(java.io.File jarFile, boolean recursive, java.util.List<java.io.File> directoriesOrFiles) Check that the dependencies present in a Class-Path manifest property do exist.Getting the Class-Path property will not be recursive.
static boolean	checkDependenciesFromFiles(java.io.File jarFile, java.io.File directory) Check that the dependencies present in a Class-Path manifest property do exist.
static boolean	checkDependenciesFromFiles(java.io.File jarFile, java.util.List<java.io.File> directoriesOrFiles) Check that the dependencies present in a Class-Path manifest property do exist.
static java.util.List<java.net.URL>	getDependencies(java.util.List<java.net.URL> jarFiles) Return list of Class-Path dependencies from a list of Jar files.
static java.util.List<java.net.URL>	getDependencies(java.util.List<java.net.URL> jarFiles, boolean recursive) Return the list of Class-Path dependencies from a list of Jar files.
static java.util.List<java.net.URL>	getDependencies(java.net.URL jarFile) Return the list of Class-Path dependencies from one Jar file.
static java.util.List<java.net.URL>	getDependencies(java.net.URL jarFile, boolean recursive) Return the list of Class-Path dependencies from one Jar file.

Methods inherited from class java.lang.Object

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

Field Detail

PRINT_ERRORS

public static boolean PRINT_ERRORS

True if errors must be printed on the console. True by default.

ALLOW_UNUSED_EXPECTED_FILES

public static boolean ALLOW_UNUSED_EXPECTED_FILES

True if files which are in the directories but not used in the ClassPath are allowed. True by default.

Method Detail

checkDependencies

public static boolean checkDependencies(java.net.URL jarFile)

Check that the dependencies present in a Class-Path manifest property do exist. Getting the Class-Path property will not be recursive.

Parameters:

jarFile - the jar file

Returns:

true if the dependencies present in a Class-Path manifest property do exist

checkDependencies

public static boolean checkDependencies(java.net.URL jarFile,
                                        boolean recursive)

Check that the dependencies present in a Class-Path manifest property do exist.

Parameters:

jarFile - the jar file

recursive - true if the handling of Class-path should be recursive

Returns:

true if the dependencies present in a Class-Path manifest property do exist

checkDependenciesFromFiles

public static boolean checkDependenciesFromFiles(java.io.File jarFile,
                                                 java.io.File directory)

Check that the dependencies present in a Class-Path manifest property do exist. Getting the Class-Path property will not be recursive.

Parameters:

jarFile - the jar file

directory - the directory to look for the expected dependencies

Returns:

true if the dependencies present in a Class-Path manifest property do exist

checkDependenciesFromFiles

public static boolean checkDependenciesFromFiles(java.io.File jarFile,
                                                 java.util.List<java.io.File> directoriesOrFiles)

Check that the dependencies present in a Class-Path manifest property do exist. Getting the Class-Path property will not be recursive.

Parameters:

jarFile - the jar file

directoriesOrFiles - the directories or files to look for the expected dependencies

Returns:

true if the dependencies present in a Class-Path manifest property do exist

checkDependenciesFromFiles

public static boolean checkDependenciesFromFiles(java.io.File jarFile,
                                                 boolean recursive,
                                                 java.util.List<java.io.File> directoriesOrFiles)

Check that the dependencies present in a Class-Path manifest property do exist.Getting the Class-Path property will not be recursive.

Parameters:

jarFile - the jar file

recursive - true if the handling of Class-path should be recursive

directoriesOrFiles - the directories or files to look for the expected dependencies

Returns:

true if the dependencies present in a Class-Path manifest property do exist

checkDependenciesFromFiles

public static boolean checkDependenciesFromFiles(java.io.File jarFile,
                                                 boolean recursive,
                                                 java.io.File directory)

Check that the dependencies present in a Class-Path manifest property do exist.Getting the Class-Path property will not be recursive.

Parameters:

jarFile - the jar file

recursive - true if the handling of Class-path should be recursive

directory - the directory to look for the expected dependencies

Returns:

true if the dependencies present in a Class-Path manifest property do exist

checkDependencies

public static boolean checkDependencies(java.net.URL jarFile,
                                        java.util.List<java.net.URL> directories)

Check that the dependencies present in a Class-Path manifest property do exist. Getting the Class-Path property will not be recursive.

Parameters:

jarFile - the jar file

directories - the directories to look for the expected dependencies

Returns:

true if the dependencies present in a Class-Path manifest property do exist

checkDependencies

public static boolean checkDependencies(java.net.URL jarFile,
                                        java.util.List<java.net.URL> directories,
                                        java.util.Set<java.lang.String> excludedExpectedJars)

Check that the dependencies present in a Class-Path manifest property do exist. Getting the Class-Path property will not be recursive.

Parameters:

jarFile - the jar file

directories - the directories to look for the expected dependencies

excludedExpectedJars - the jar file names to exclude from the list of expected dependencies

Returns:

true if the dependencies present in a Class-Path manifest property do exist

checkDependencies

public static boolean checkDependencies(java.net.URL jarFile,
                                        java.net.URL directory,
                                        java.util.Set<java.lang.String> excludedExpectedJars)

Check that the dependencies present in a Class-Path manifest property do exist. Getting the Class-Path property will not be recursive.

Parameters:

jarFile - the jar file

directory - the directory to look for the expected dependencies

excludedExpectedJars - the jar file names to exclude from the list of expected dependencies

Returns:

true if the dependencies present in a Class-Path manifest property do exist

checkDependencies

public static boolean checkDependencies(java.net.URL jarFile,
                                        boolean recursive,
                                        java.net.URL directory,
                                        java.util.Set<java.lang.String> excludedInputJars,
                                        java.util.Set<java.lang.String> excludedExpectedJars)

Check that the dependencies present in a Class-Path manifest property do exist.

Parameters:

jarFile - the jar file

recursive - true if the handling of Class-path should be recursive

directory - the directory to look for the expected dependencies

excludedInputJars - he jar file names to exclude from the list of returned Class-path dependencies

excludedExpectedJars - the jar file names to exclude from the list of expected dependencies

Returns:

true if the dependencies present in a Class-Path manifest property do exist

checkDependencies

public static boolean checkDependencies(java.net.URL jarFile,
                                        boolean recursive,
                                        java.net.URL directory,
                                        java.util.Set<java.lang.String> excludedExpectedJars)

Check that the dependencies present in a Class-Path manifest property do exist.

Parameters:

jarFile - the jar file

recursive - true if the handling of Class-path should be recursive

directory - the directory to look for the expected dependencies

excludedExpectedJars - the jar file names to exclude from the list of expected dependencies

Returns:

true if the dependencies present in a Class-Path manifest property do exist

checkDependencies

public static boolean checkDependencies(java.net.URL jarFile,
                                        boolean recursive,
                                        java.util.List<java.net.URL> directories,
                                        java.util.Set<java.lang.String> excludedInputJars,
                                        java.util.Set<java.lang.String> excludedExpectedJars)

Check that the dependencies present in a Class-Path manifest property do exist.

Parameters:

jarFile - the jar file

recursive - true if the handling of Class-path should be recursive

directories - the directories to look for the expected dependencies

excludedInputJars - he jar file names to exclude from the list of returned Class-path dependencies

excludedExpectedJars - the jar file names to exclude from the list of expected dependencies

Returns:

true if the dependencies present in a Class-Path manifest property do exist

getDependencies

public static java.util.List<java.net.URL> getDependencies(java.net.URL jarFile)

Return the list of Class-Path dependencies from one Jar file. Getting the Class-Path property will not be recursive.

Parameters:

jarFile - the jar file

Returns:

the list of Class-Path dependencies

getDependencies

public static java.util.List<java.net.URL> getDependencies(java.net.URL jarFile,
                                                           boolean recursive)

Return the list of Class-Path dependencies from one Jar file.

Parameters:

jarFile - the jar file

recursive - true if the handling of Class-path should be recursive

Returns:

the list of Class-Path dependencies

getDependencies

public static java.util.List<java.net.URL> getDependencies(java.util.List<java.net.URL> jarFiles)

Return list of Class-Path dependencies from a list of Jar files. Getting the Class-Path property will not be recursive.

Parameters:

jarFiles - the list of jar files

Returns:

the list of Class-Path dependencies

getDependencies

public static java.util.List<java.net.URL> getDependencies(java.util.List<java.net.URL> jarFiles,
                                                           boolean recursive)

Return the list of Class-Path dependencies from a list of Jar files.

Parameters:

jarFiles - the list of jar files

recursive - true if the handling of Class-path should be recursive

Returns:

the list of Class-Path dependencies