Class Walker

java.lang.Object

org.apache.rat.walker.Walker

All Implemented Interfaces:

Reportable

Direct Known Subclasses:

ArchiveWalker, DirectoryWalker

public abstract class Walker
extends Object
implements Reportable

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	name()	Returns the DocumentName for the reportable.

Methods inherited from class Object

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

Methods inherited from interface Reportable

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.

name

public DocumentName name()

Description copied from interface: Reportable

Returns the DocumentName for the reportable.

Specified by:

name in interface Reportable

Returns:

the DocumentName for the reportable.