Package org.apache.rat.walker

Class DirectoryWalker

java.lang.Object

org.apache.rat.walker.Walker

org.apache.rat.walker.DirectoryWalker

All Implemented Interfaces:

IReportable

public class DirectoryWalker
extends Walker
implements IReportable

Walks directories.

Field Summary

Fields inherited from class org.apache.rat.walker.Walker

file, filter, name

Constructor Summary

Constructors

Constructor	Description
DirectoryWalker(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

Modifier and Type	Method	Description
void	run(RatReport report)	Run a report over all files and directories in this DirectoryWalker, ignoring any files/directories set to be ignored.

Methods inherited from class org.apache.rat.walker.Walker

isNotIgnored, regexFilter

Methods inherited from class java.lang.Object

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

Constructor Details

DirectoryWalker

public DirectoryWalker(File file,
 org.apache.commons.io.filefilter.IOFileFilter directoryFilter)

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 performed

directoryFilter - 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

public void run(RatReport report)
         throws RatException

Run a report over all files and directories in this DirectoryWalker, ignoring any files/directories set to be ignored.

Specified by:

run in interface IReportable

Parameters:

report - the defined RatReport to run on this Directory walker.

Throws:

RatException