001: /* ====================================================================
002: * The JRefactory License, Version 1.0
003: *
004: * Copyright (c) 2001 JRefactory. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions
008: * are met:
009: *
010: * 1. Redistributions of source code must retain the above copyright
011: * notice, this list of conditions and the following disclaimer.
012: *
013: * 2. Redistributions in binary form must reproduce the above copyright
014: * notice, this list of conditions and the following disclaimer in
015: * the documentation and/or other materials provided with the
016: * distribution.
017: *
018: * 3. The end-user documentation included with the redistribution,
019: * if any, must include the following acknowledgment:
020: * "This product includes software developed by the
021: * JRefactory (http://www.sourceforge.org/projects/jrefactory)."
022: * Alternately, this acknowledgment may appear in the software itself,
023: * if and wherever such third-party acknowledgments normally appear.
024: *
025: * 4. The names "JRefactory" must not be used to endorse or promote
026: * products derived from this software without prior written
027: * permission. For written permission, please contact seguin@acm.org.
028: *
029: * 5. Products derived from this software may not be called "JRefactory",
030: * nor may "JRefactory" appear in their name, without prior written
031: * permission of Chris Seguin.
032: *
033: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
034: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
035: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
036: * DISCLAIMED. IN NO EVENT SHALL THE CHRIS SEGUIN OR
037: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
038: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
039: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
040: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
041: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
042: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
043: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
044: * SUCH DAMAGE.
045: * ====================================================================
046: *
047: * This software consists of voluntary contributions made by many
048: * individuals on behalf of JRefactory. For more information on
049: * JRefactory, please see
050: * <http://www.sourceforge.org/projects/jrefactory>.
051: */
052: package org.acm.seguin.tools.build;
053:
054: import java.io.*;
055: import java.util.LinkedList;
056: import org.acm.seguin.io.DirectoryTreeTraversal;
057:
058: /**
059: * Tool that creates a list of packages to be processed by javadoc
060: *
061: *@author Chris Seguin
062: *@created September 12, 2001
063: */
064: public class JavadocBuilder extends DirectoryTreeTraversal {
065: private LinkedList directoryList;
066: private PrintWriter output;
067: private int rootLength;
068: private boolean first;
069: private int directoryCount;
070:
071: private final static int MAX_DIRS = 5;
072:
073: /**
074: * Constructor for the JarDirectoryBuilder object
075: *
076: *@param rootDir the directory
077: *@param out the output stream
078: */
079: public JavadocBuilder(String rootDir, PrintWriter out) {
080: super (rootDir);
081: directoryList = new LinkedList();
082: output = out;
083: first = true;
084: rootLength = rootDir.length();
085: directoryCount = 0;
086: }
087:
088: /**
089: * Determines if this file should be handled by this traversal
090: *
091: *@param currentFile the current file
092: *@return true if the file should be handled
093: */
094: protected boolean isTarget(File currentFile) {
095: return currentFile.getName().endsWith(".java");
096: }
097:
098: /**
099: * Visits the current file
100: *
101: *@param currentFile the current file
102: */
103: protected void visit(File currentFile) {
104: String parentString = currentFile.getParent();
105: if (!directoryList.contains(parentString)) {
106: directoryList.add(parentString);
107:
108: if (parentString.length() == rootLength) {
109: //output.println("*.java");
110: } else {
111: String dir = parentString.substring(rootLength + 1);
112: String packageName = convert(dir);
113: output.println(packageName);
114: }
115: }
116: }
117:
118: /**
119: * Converts a directory path into a package name
120: *
121: *@param value The directory path
122: *@return the package name
123: */
124: private String convert(String value) {
125: StringBuffer buffer = new StringBuffer();
126: for (int ndx = 0; ndx < value.length(); ndx++) {
127: if ((value.charAt(ndx) == '\\')
128: || (value.charAt(ndx) == '/')) {
129: buffer.append(".");
130: } else {
131: buffer.append(value.charAt(ndx));
132: }
133: }
134:
135: return buffer.toString();
136: }
137:
138: /**
139: * The main program for the JarDirectoryBuilder class
140: *
141: *@param args The command line arguments
142: */
143: public static void main(String[] args) {
144: String jarFile = "sample.jar";
145: String directory = System.getProperty("user.dir");
146: PrintWriter out = null;
147:
148: try {
149: if (args.length > 0) {
150: out = new PrintWriter(new FileWriter(args[0]));
151: } else {
152: out = new PrintWriter(
153: new OutputStreamWriter(System.out));
154: }
155: } catch (IOException ioe) {
156: System.out.println("Unable to create the output file: "
157: + args[0]);
158: return;
159: }
160:
161: if (args.length > 1) {
162: directory = args[1];
163: }
164:
165: (new JavadocBuilder(directory, out)).run();
166:
167: out.println("");
168:
169: out.flush();
170: out.close();
171: }
172: }
|