org.apache.rat
Class DirectoryWalker

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

public class DirectoryWalker
extends java.lang.Object
implements IReportable

Walks directories.


Field Summary
protected  java.io.File file
           
protected  java.lang.String name
           
 
Constructor Summary
DirectoryWalker(java.io.File file)
           
DirectoryWalker(java.io.File file, java.util.regex.Pattern ignoreNameRegex)
           
 
Method Summary
protected  boolean ignored(java.lang.String name)
           
 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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

file

protected final java.io.File file

name

protected final java.lang.String name
Constructor Detail

DirectoryWalker

public DirectoryWalker(java.io.File file)

DirectoryWalker

public DirectoryWalker(java.io.File file,
                       java.util.regex.Pattern ignoreNameRegex)
Method Detail

isRestricted

public boolean isRestricted()

ignored

protected final boolean ignored(java.lang.String name)

run

public void run(RatReport report)
         throws RatReportFailedException
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:
RatReportFailedException


Copyright © 2006-2009 The Apache Software Foundation. All Rights Reserved.