Package org.apache.rat.walker
Class DirectoryWalker
java.lang.Object
org.apache.rat.walker.Walker
org.apache.rat.walker.DirectoryWalker
- All Implemented Interfaces:
IReportable
Walks directories.
-
Field Summary
-
Constructor Summary
ConstructorDescriptionDirectoryWalker(File file, FilenameFilter filter, org.apache.commons.io.filefilter.IOFileFilter directoryFilter)
Constructs a walker.DirectoryWalker(File file, Pattern ignoreNameRegex, org.apache.commons.io.filefilter.IOFileFilter directoryFilter)
Constructs a walker.DirectoryWalker(File file, org.apache.commons.io.filefilter.IOFileFilter directoryFilter)
Constructs a walker. -
Method Summary
Methods inherited from class org.apache.rat.walker.Walker
isNotIgnored, regexFilter
-
Constructor Details
-
DirectoryWalker
Constructs a walker.- Parameters:
file
- the directory to walk.directoryFilter
- directory filter to eventually exclude some directories/files from the scan.
-
DirectoryWalker
public DirectoryWalker(File file, FilenameFilter filter, org.apache.commons.io.filefilter.IOFileFilter directoryFilter)Constructs a walker.- Parameters:
file
- the directory to walk (not null).filter
- filters input files (optional), or null when no filtering should be performeddirectoryFilter
- filters directories (optional), or null when no filtering should be performed.
-
DirectoryWalker
public DirectoryWalker(File file, Pattern ignoreNameRegex, org.apache.commons.io.filefilter.IOFileFilter directoryFilter)Constructs a walker.- Parameters:
file
- the directory to walk (not null).ignoreNameRegex
- ignore directories/files with name matching the regex.directoryFilter
- filters directories (optional), or null when no filtering should be performed.
-
-
Method Details
-
run
Run a report over all files and directories in this DirectoryWalker, ignoring any files/directories set to be ignored.- Specified by:
run
in interfaceIReportable
- Parameters:
report
- the defined RatReport to run on this Directory walker.- Throws:
RatException
-