org.jdepend.utils

Class DependencyUtilities

java.lang.Object

org.jdepend.utils.DependencyUtilities

public class DependencyUtilities
extends java.lang.Object

Dependency utilities methods. This class allows to test if a jar file (defined in a JarDependencies class) depends on the Swing or JavaFX framework.

Method Summary

Modifier and Type	Method and Description
static boolean	dependOnDesktop(JarDependencies depend) Return the dependencies between a jar file and the packages defined in the java.desktop module.
static boolean	dependOnJavaFX(JarDependencies depend) Return true if the jar file denoted by the JarDependencies depend on the JavaFX framework.
static boolean	dependOnSwing(JarDependencies depend) Return the dependencies between a jar file denoted by the JarDependencies and the Swing framework.
static ClassDependencies	getDependencies(JarDependencies dependencies, java.lang.String packageFrom, java.lang.String packageTo) Return the internal dependencies between two packages in a JarDependencies.
static java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	getJavaFXDependencies(JarDependencies depend) Return the dependencies between a jar file denoted by the JarDependencies and the JavaFX framework.
static java.lang.String	getPackage(java.lang.String path) Return the package name for a class path.
static java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	getSwingDependencies(JarDependencies depend) Return true if the jar file denoted by the JarDependencies depend on the Swing framework.
static boolean	hasDependencies(JarDependencies dependencies, java.lang.String packageFrom, java.lang.String packageTo) Return true if there are internal dependencies between two packages in a JarDependencies.

Methods inherited from class java.lang.Object

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

Method Detail

getPackage

public static java.lang.String getPackage(java.lang.String path)

Return the package name for a class path.

Parameters:

path - the class path

Returns:

the package name (or null for the default package)

dependOnJavaFX

public static boolean dependOnJavaFX(JarDependencies depend)

Return true if the jar file denoted by the JarDependencies depend on the JavaFX framework.

Parameters:

depend - the JarDependencies

Returns:

true if the jar file denoted by the JarDependencies depend on the JavaFX framework

getJavaFXDependencies

public static java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getJavaFXDependencies(JarDependencies depend)

Return the dependencies between a jar file denoted by the JarDependencies and the JavaFX framework.

Parameters:

depend - the JarDependencies

Returns:

true if the jar file denoted by the JarDependencies depend on the JavaFX framework

dependOnDesktop

public static boolean dependOnDesktop(JarDependencies depend)

Return the dependencies between a jar file and the packages defined in the java.desktop module.

Parameters:

depend - the JarDependencies

Returns:

true if there are between the jar file and the packages defined in the java.desktop module

dependOnSwing

public static boolean dependOnSwing(JarDependencies depend)

Return the dependencies between a jar file denoted by the JarDependencies and the Swing framework.

Parameters:

depend - the JarDependencies

Returns:

true if the jar file denoted by the JarDependencies depend on the Swing framework

getSwingDependencies

public static java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getSwingDependencies(JarDependencies depend)

Return true if the jar file denoted by the JarDependencies depend on the Swing framework.

Parameters:

depend - the JarDependencies

Returns:

true if the jar file denoted by the JarDependencies depend on the Swing framework

hasDependencies

public static boolean hasDependencies(JarDependencies dependencies,
                                      java.lang.String packageFrom,
                                      java.lang.String packageTo)

Return true if there are internal dependencies between two packages in a JarDependencies. Note that it is possible to check all the internal dependencies against one package by setting packageTo to null.

Parameters:

dependencies - the jar file or class files directory which we seek to look

packageFrom - the package from which we look for the dependencies. If null, the method will look for dependencies for all packages against the packageTo package (excluding packageTo itself)

packageTo - the package in which we lok for the dependencies

Returns:

true if there are internal dependencies from the first package on the second package

getDependencies

public static ClassDependencies getDependencies(JarDependencies dependencies,
                                                java.lang.String packageFrom,
                                                java.lang.String packageTo)

Return the internal dependencies between two packages in a JarDependencies. Note that it is possible to get all the internal dependencies against one package by setting packageTo to null.

Parameters:

dependencies - the jar file or class files directory which we seek to look

packageFrom - the package from which we look for the dependencies. If null, the method will look for dependencies for all packages against the packageTo package (excluding packageTo itself)

packageTo - the package in which we look for the dependencies

Returns:

the dependencies from the first package on the second package