Package org.apache.rat.walker

Class ArchiveWalker

java.lang.Object

org.apache.rat.walker.Walker

org.apache.rat.walker.ArchiveWalker

All Implemented Interfaces:

IReportable

public class ArchiveWalker
extends Walker

Walks various kinds of archives files.

Constructor Summary

Constructors

Constructor	Description
ArchiveWalker(Document document)	Constructs a walker.

Method Summary

Modifier and Type	Method	Description
Collection<Document>	getDocuments()	Retrieves the documents from the archive.
void	run(RatReport report)	Run a report over all files and directories in this GZIPWalker, 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

ArchiveWalker

public ArchiveWalker(Document document)

Constructs a 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 GZIPWalker, ignoring any files/directories set to be ignored.

Parameters:

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

Throws:

RatException - on error.

getDocuments

public Collection<Document> getDocuments()
                                  throws RatException

Retrieves the documents from the archive.

Returns:

A collection of documents that pass the file filter.

Throws:

RatException - on error.