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

Walks directories.

Constructor Summary

Constructors

Constructor	Description
DirectoryWalker(Document document)	Constructs a directory walker.

Method Summary

Modifier and Type	Method	Description
protected void	process(RatReport report, Document document)	Process a directory, ignoring any files/directories set to be ignored.
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

getDocument, getName

Methods inherited from class java.lang.Object

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

Constructor Details

DirectoryWalker

public DirectoryWalker(Document document)

Constructs a directory walker.

Parameters:

document - the document to process.

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.

Parameters:

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

Throws:

RatException - on error

process

protected void process(RatReport report,
 Document document)
                throws RatException

Process a directory, ignoring any files/directories set to be ignored.

Parameters:

report - the report to use in processing

document - the document to run the report against

Throws:

RatException - on error