jdepend.framework

Class PackageFilter

public class PackageFilter extends Object

The PackageFilter class is used to filter imported package names.

The default filter contains any packages declared in the jdepend.properties file, if such a file exists either in the user's home directory or somewhere in the classpath.

Author: Mike Clark (mike@clarkware.com) Clarkware Consulting, Inc.

Constructor Summary
PackageFilter()
Constructs a PackageFilter instance containing the filters specified in the jdepend.properties file, if it exists.
PackageFilter(File f)
Constructs a PackageFilter instance containing the filters contained in the specified file.
PackageFilter(Collection packageNames)
Constructs a PackageFilter instance with the specified collection of package names to filter.
Method Summary
booleanaccept(String packageName)
Indicates whether the specified package name passes this package filter.
voidaddPackage(String packageName)
voidaddPackages(Collection packageNames)
CollectiongetFilters()
Returns the collection of filtered package names.

Constructor Detail

PackageFilter

public PackageFilter()
Constructs a PackageFilter instance containing the filters specified in the jdepend.properties file, if it exists.

PackageFilter

public PackageFilter(File f)
Constructs a PackageFilter instance containing the filters contained in the specified file.

Parameters: f Property file.

PackageFilter

public PackageFilter(Collection packageNames)
Constructs a PackageFilter instance with the specified collection of package names to filter.

Parameters: packageNames Package names to filter.

Method Detail

accept

public boolean accept(String packageName)
Indicates whether the specified package name passes this package filter.

Parameters: packageName Package name.

Returns: true if the package name should be included; false otherwise.

addPackage

public void addPackage(String packageName)

addPackages

public void addPackages(Collection packageNames)

getFilters

public Collection getFilters()
Returns the collection of filtered package names.

Returns: Filtered package names.

Copyright B) 1999-2003 Clarkware Consulting, Inc.