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
implements IReportable

Walks various kinds of archives files

Field Summary

Fields inherited from class org.apache.rat.walker.Walker

file, filter, name

Constructor Summary

Constructors

Constructor and Description
ArchiveWalker(java.io.File file, java.io.FilenameFilter filter) Constructs a walker.

Method Summary

Modifier and Type	Method and Description
private void	report(RatReport report, byte[] contents, java.io.File file) Report on the given file.
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

isNotIgnored, isRestricted, regexFilter

Methods inherited from class java.lang.Object

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

Constructor Detail

ArchiveWalker

public ArchiveWalker(java.io.File file,
                     java.io.FilenameFilter filter)
              throws java.io.FileNotFoundException

Constructs a walker.

Parameters:

file - not null

filter - filters input files (optional), or null when no filtering should be performed

Throws:

java.io.FileNotFoundException - in case of I/O errors.

Method Detail

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.

Specified by:

run in interface IReportable

Parameters:

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

Throws:

RatException

report

private void report(RatReport report,
                    byte[] contents,
                    java.io.File file)
             throws RatException

Report on the given file.

Parameters:

report - the report to process the file with

file - the file to be reported on

Throws:

RatException