KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > aspectj > tools > ajdoc > RootDocMaker


1 /* -*- Mode: JDE; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
2  *
3  * This file is part of the debugger and core tools for the AspectJ(tm)
4  * programming language; see http://aspectj.org
5  *
6  * The contents of this file are subject to the Mozilla Public License
7  * Version 1.1 (the "License"); you may not use this file except in
8  * compliance with the License. You may obtain a copy of the License at
9  * either http://www.mozilla.org/MPL/ or http://aspectj.org/MPL/.
10  *
11  * Software distributed under the License is distributed on an "AS IS" basis,
12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13  * for the specific language governing rights and limitations under the
14  * License.
15  *
16  * The Original Code is AspectJ.
17  *
18  * The Initial Developer of the Original Code is Xerox Corporation. Portions
19  * created by Xerox Corporation are Copyright (C) 1999-2002 Xerox Corporation.
20  * All Rights Reserved.
21  */

22 package org.aspectj.tools.ajdoc;
23
24 import com.sun.javadoc.DocErrorReporter;
25 import com.sun.javadoc.RootDoc;
26
27 import java.util.List JavaDoc;
28
29 /**
30  * Interface specifying types that
31  * can produce RootDocs.
32  *
33  * @author Jeff Palm
34  */

35 public interface RootDocMaker {
36
37     /**
38      * Returns a RootDoc using the passed in parameters.
39      * Throw a CannotMakeRootDocException is something
40      * goes awry.
41      *
42      * @param sourcepath sourcepath to use.
43      * @param classpath classpath to use.
44      * @param bootclasspath bootclasspath to use.
45      * @param extdirs extdirs to use.
46      * @param flags flags to use.
47      * @param encoding encoding to use.
48      * @param locale locale to use.
49      * @param source source to use.
50      * @param filenamesAndPackages filenamesAndPackages to use.
51      * @param options options to use.
52      * @param err ErrPrinter to use.
53      * @param programName program name to use.
54      * @param filter filter to use.
55      * @return a RootDoc.
56      */

57     public RootDoc makeRootDoc(String JavaDoc sourcepath,
58                                String JavaDoc classpath,
59                                String JavaDoc bootclasspath,
60                                String JavaDoc extdirs,
61                                long flags,
62                                String JavaDoc encoding,
63                                String JavaDoc locale,
64                                String JavaDoc source,
65                                List JavaDoc filenamesAndPackages,
66                                List JavaDoc options,
67                                DocErrorReporter err,
68                                String JavaDoc programName,
69                                AccessChecker filter)
70     throws CannotMakeRootDocException;
71                                
72 }
73
Popular Tags