org.acm.seguin.tools.build
Class JavadocBuilder

java.lang.Object
  extended by org.acm.seguin.io.DirectoryTreeTraversal
      extended by org.acm.seguin.tools.build.JavadocBuilder
All Implemented Interfaces:
java.lang.Runnable

public class JavadocBuilder
extends DirectoryTreeTraversal

Tool that creates a list of packages to be processed by javadoc

Author:
Chris Seguin

Constructor Summary
JavadocBuilder(java.lang.String rootDir, java.io.PrintWriter out)
          Constructor for the JarDirectoryBuilder object
 
Method Summary
protected  boolean isTarget(java.io.File currentFile)
          Determines if this file should be handled by this traversal
static void main(java.lang.String[] args)
          The main program for the JarDirectoryBuilder class
protected  void visit(java.io.File currentFile)
          Visits the current file
 
Methods inherited from class org.acm.seguin.io.DirectoryTreeTraversal
arriveAtDir, isAllowed, leaveDir, run, traverse
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JavadocBuilder

public JavadocBuilder(java.lang.String rootDir,
                      java.io.PrintWriter out)
Constructor for the JarDirectoryBuilder object

Parameters:
rootDir - the directory
out - the output stream
Method Detail

isTarget

protected boolean isTarget(java.io.File currentFile)
Determines if this file should be handled by this traversal

Specified by:
isTarget in class DirectoryTreeTraversal
Parameters:
currentFile - the current file
Returns:
true if the file should be handled

visit

protected void visit(java.io.File currentFile)
Visits the current file

Specified by:
visit in class DirectoryTreeTraversal
Parameters:
currentFile - the current file

main

public static void main(java.lang.String[] args)
The main program for the JarDirectoryBuilder class

Parameters:
args - The command line arguments