org.jdepend.action

Class PackagePath

java.lang.Object

org.jdepend.action.PackagePath

All Implemented Interfaces:

java.util.Comparator<PackagePath>

public class PackagePath
extends java.lang.Object
implements java.util.Comparator<PackagePath>

Represent a package or class path.

Since:

1.4.8

Constructor Summary

Constructors

Constructor and Description
PackagePath(java.lang.String path) Constructor.
PackagePath(java.lang.String path, java.util.Set<java.lang.String> excludedClasses) Constructor.
PackagePath(java.lang.String path, java.lang.String... excludedClasses) Constructor.

Method Summary

Modifier and Type	Method and Description
int	compare(PackagePath o1, PackagePath o2)
static java.util.Set<PackagePath>	createPackagePaths(java.util.Set<java.lang.String> paths) Creates a set of package paths from a Set of paths as strings.
static java.util.Set<PackagePath>	createPackagePaths(java.util.Set<java.lang.String> paths, java.util.Set<java.lang.String> excludedClasses) Creates a set of package paths from a Set of paths as strings.
static java.util.Set<PackagePath>	createPackagePathsFromArray(java.util.Set<java.lang.String> excludedClasses, java.lang.String... paths) Creates a set of package paths from an array.
static java.util.Set<PackagePath>	createPackagePathsFromArray(java.lang.String... paths) Creates a set of package paths from an array.
boolean	equals(java.lang.Object obj)
void	excludeClass(java.lang.String classpath) Excludes a class fropm the package.
java.util.Set<java.lang.String>	getExcludedClasses() Return the Set fo excluded classes.
java.lang.String	getPackageName() The package name
java.lang.String	getPath() The package path.
int	hashCode()
boolean	isExcludingClass(java.lang.String classpath) Return true if a class is excluded.
boolean	isPackageName() Return true if if represents a package.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Constructor Detail

PackagePath

public PackagePath(java.lang.String path)

Constructor.

Parameters:

path - the path

PackagePath

public PackagePath(java.lang.String path,
                   java.lang.String... excludedClasses)

Constructor.

Parameters:

path - the path

excludedClasses - a list of classes excluded from the package

PackagePath

public PackagePath(java.lang.String path,
                   java.util.Set<java.lang.String> excludedClasses)

Constructor.

Parameters:

path - the path

excludedClasses - a set of classes excluded from the package

Method Detail

createPackagePathsFromArray

public static java.util.Set<PackagePath> createPackagePathsFromArray(java.lang.String... paths)

Creates a set of package paths from an array.

Parameters:

paths - the array

Returns:

the set of package paths

createPackagePaths

public static java.util.Set<PackagePath> createPackagePaths(java.util.Set<java.lang.String> paths)

Creates a set of package paths from a Set of paths as strings.

Parameters:

paths - the Set of paths

Returns:

the set of package paths

createPackagePathsFromArray

public static java.util.Set<PackagePath> createPackagePathsFromArray(java.util.Set<java.lang.String> excludedClasses,
                                                                     java.lang.String... paths)

Creates a set of package paths from an array.

Parameters:

excludedClasses - a set of excluded classes

paths - the array

Returns:

the set of package paths

createPackagePaths

public static java.util.Set<PackagePath> createPackagePaths(java.util.Set<java.lang.String> paths,
                                                            java.util.Set<java.lang.String> excludedClasses)

Creates a set of package paths from a Set of paths as strings.

Parameters:

paths - the Set of paths

excludedClasses - a set of excluded classes

Returns:

the set of package paths

getPath

public java.lang.String getPath()

The package path.

Returns:

the path

getPackageName

public java.lang.String getPackageName()

The package name

Returns:

the package name

isPackageName

public boolean isPackageName()

Return true if if represents a package.

Returns:

true if if represents a package

excludeClass

public void excludeClass(java.lang.String classpath)

Excludes a class fropm the package.

Parameters:

classpath - the class classpath

getExcludedClasses

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

Return the Set fo excluded classes.

Returns:

the Set fo excluded classes

isExcludingClass

public boolean isExcludingClass(java.lang.String classpath)

Return true if a class is excluded.

Parameters:

classpath - the class classpath

Returns:

true if the class is excluded

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface java.util.Comparator<PackagePath>

Overrides:

equals in class java.lang.Object

compare

public int compare(PackagePath o1,
                   PackagePath o2)

Specified by:

compare in interface java.util.Comparator<PackagePath>