Package org.apache.rat.walker

Class Walker

java.lang.Object

org.apache.rat.walker.Walker

All Implemented Interfaces:

IReportable

Direct Known Subclasses:

ArchiveWalker, DirectoryWalker

public abstract class Walker
extends Object
implements IReportable

Abstract walker.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Walker(Document document)	Creates the walker

Method Summary

Modifier and Type	Method	Description
protected Document	getDocument()	Retrieves the document from the constructor.
DocumentName	getName()	Returns the DocumentName for the reportable.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.rat.report.IReportable

run

Constructor Details

Walker

protected Walker(Document document)

Creates the walker

Parameters:

document - The document the walker is walking.

Method Details

getDocument

protected Document getDocument()

Retrieves the document from the constructor.

Returns:

the document from the constructor.

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.