Package org.apache.rat.walker

Class FileListWalker

java.lang.Object

org.apache.rat.walker.FileListWalker

All Implemented Interfaces:

IReportable

public class FileListWalker
extends Object
implements IReportable

Implementation of IReportable that traverses over a resource collection internally.

Constructor Summary

Constructors

Constructor	Description
FileListWalker(FileDocument source)	Constructor.

Method Summary

Modifier and Type	Method	Description
DocumentName	getName()	Returns the DocumentName for the reportable.
void	run(RatReport report)	Adds the reportable to the RatReport.

Methods inherited from class java.lang.Object

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

Constructor Details

FileListWalker

public FileListWalker(FileDocument source)

Constructor.

Parameters:

source - The file document that is the source from which this walker will read.

Method Details

run

public void run(RatReport report)
         throws RatException

Description copied from interface: IReportable

Adds the reportable to the RatReport.

Specified by:

run in interface IReportable

Parameters:

report - the report to add the results to.

Throws:

RatException - on error.

getName

public DocumentName getName()

Description copied from interface: IReportable

Returns the DocumentName for the reportable.

Specified by:

getName in interface IReportable

Returns:

the DocumentName for the reportable.