org.jorion.jdepend
Class PackageFilter

java.lang.Object
  org.jorion.jdepend.PackageFilter

public class PackageFilter
extends java.lang.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, Clarkware Consulting, Inc.

Constructor Summary

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

PackageFilter(java.util.Collection<java.lang.String> packageNames)
Constructs a PackageFilter instance with the specified collection of package names to filter.

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

Method Summary

boolean	accept(java.lang.String packageName) Indicates whether the specified package name passes this package filter.
void	addPackage(java.lang.String packageName)
void	addPackages(java.util.Collection<java.lang.String> packageNames)
java.util.Collection<java.lang.String>	getFilters() Returns the collection of filtered package names.

Methods inherited from class java.lang.Object

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

Constructor Detail

PackageFilter

public PackageFilter()

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

PackageFilter

public PackageFilter(java.io.File f)

Constructs a PackageFilter instance containing the filters contained in the specified file.

Parameters:

f - Property file.

PackageFilter

public PackageFilter(java.util.Collection<java.lang.String> packageNames)

Constructs a PackageFilter instance with the specified collection of package names to filter.

Parameters:

packageNames - Package names to filter.

Method Detail

getFilters

public java.util.Collection<java.lang.String> getFilters()

Returns the collection of filtered package names.

Returns:

Filtered package names.

accept

public boolean accept(java.lang.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.

addPackages

public void addPackages(java.util.Collection<java.lang.String> packageNames)

Parameters:

packageNames - The package collection to add.

addPackage

public void addPackage(java.lang.String packageName)

Parameters:

packageName - The package to add.