jvanzyl 02/03/24 13:46:13 Modified: src/java/org/apache/maven ProjectResolver.java Log: Adding javadoc to the project resolver. Revision Changes Path 1.4 +62 -4 jakarta-turbine-maven/src/java/org/apache/maven/ProjectResolver.java Index: ProjectResolver.java =================================================================== RCS file: /home/cvs/jakarta-turbine-maven/src/java/org/apache/maven/ProjectResolver.java,v retrieving revision 1.3 retrieving revision 1.4 diff -u -r1.3 -r1.4 --- ProjectResolver.java 21 Mar 2002 02:31:39 -0000 1.3 +++ ProjectResolver.java 24 Mar 2002 21:46:13 -0000 1.4 @@ -69,19 +69,58 @@ import org.apache.maven.importscrubber.ClassParserWrapper; import org.apache.maven.importscrubber.TreeMapListener; +/** + * <code>ProjectResolver</code> is an executor that will process + * a directory looking for JAR and class files and turn the set + * class references it finds into a set of project references + * which can be used to create an accurate set of dependencies + * in a project descriptor. + * + * @author <a href="mailto:[EMAIL PROTECTED]";>Jason van Zyl</a> + * @version $Id: ProjectResolver.java,v 1.4 2002/03/24 21:46:13 jvanzyl Exp $ + */ public class ProjectResolver { + /** + * Base directory in which JAR files and class files will + * be searched for. + */ private File file; + + /** + * Listener that registers class references as they + * are found by the {@link org.apache.maven.importscrubber.ClassParserWrapper} + */ private TreeMapListener treeMapListener; + + /** + * Package references that are collected by mapping the class references + * to package references. + */ private List packageReferences; + + /** + * Packages to exclude from the final list of packages. + */ private List packageExcludes; + /** + * Default constructor. + */ public ProjectResolver() { packageReferences = new LinkedList(); packageExcludes = new LinkedList(); } - + + /** + * Set the packages to exclude from the final list found + * by the resolution process. + * + * @param String packageExcludesList Comma separate list of + * the packages to exclude from the final list of + * packages. + */ public void setPackageExcludes(String packageExcludesList) { StringTokenizer st = new StringTokenizer(packageExcludesList,","); @@ -92,17 +131,33 @@ } } + /** + * Set the directory in which JARs and class files are + * searched for. + * + * @param baseDirectory Directory in which JARs and class files + * are searched for. + */ public void setFile(File file) { - System.out.println("setting file: " + file); this.file = file; } + /** + * Get the package referenced determined by the resolution + * process. + * + * @return List The list of packages references found. + */ public List getPackageReferences() { return packageReferences; } - + + /** + * Resolve the package dependencies from the set of JARs + * and classes used as the input. + */ public void resolveDependencies() { JarFile jarFile = null; @@ -156,7 +211,10 @@ e.printStackTrace(); } } - + + /** + * Used for testing only. + */ public static void main(String[] args) { ProjectResolver bdr = new ProjectResolver();
-- To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]> For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
