org.apache.rat.walker
Class DirectoryWalker

java.lang.Object
  extended by org.apache.rat.walker.Walker
      extended by org.apache.rat.walker.DirectoryWalker
All Implemented Interfaces:
IReportable

public class DirectoryWalker
extends Walker
implements IReportable

Walks directories.


Field Summary
protected static org.apache.rat.walker.FileNameComparator COMPARATOR
           
 
Fields inherited from class org.apache.rat.walker.Walker
file, filter, name
 
Constructor Summary
DirectoryWalker(File file)
           
DirectoryWalker(File file, FilenameFilter filter)
          Constructs a walker.
DirectoryWalker(File file, Pattern ignoreNameRegex)
           
 
Method Summary
 boolean isRestricted()
           
 void run(RatReport report)
          Run a report over all files and directories in this DirectoryWalker, ignoring any files/directories set to be ignored.
 
Methods inherited from class org.apache.rat.walker.Walker
ignored, isRestricted, regexFilter
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COMPARATOR

protected static final org.apache.rat.walker.FileNameComparator COMPARATOR
Constructor Detail

DirectoryWalker

public DirectoryWalker(File file)

DirectoryWalker

public DirectoryWalker(File file,
                       FilenameFilter filter)
Constructs a walker.

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

DirectoryWalker

public DirectoryWalker(File file,
                       Pattern ignoreNameRegex)
Method Detail

isRestricted

public boolean isRestricted()

run

public void run(RatReport report)
         throws RatException
Run a report over all files and directories in this DirectoryWalker, ignoring any files/directories set to be ignored.

Specified by:
run in interface IReportable
Parameters:
report - the defined RatReport to run on this Directory walker.
Throws:
RatException


Copyright © 2006-2011 Apache Software Foundation. All Rights Reserved.