KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > go > beandoc > teadoc > RootDoc


1 /* ====================================================================
2  * BeanDoc - Copyright (c) 1997-2000 GO.com
3  * ====================================================================
4  * The Tea Software License, Version 1.0
5  *
6  * Copyright (c) 2000 GO.com. All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by GO.com
23  * (http://opensource.go.com/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Tea", "TeaServlet", "Kettle", "Trove", BeanDoc and "GO.com"
28  * must not be used to endorse or promote products derived from this
29  * software without prior written permission. For written
30  * permission, please contact opensource@go.com.
31  *
32  * 5. Products derived from this software may not be called "Tea",
33  * "TeaServlet", "Kettle", "Trove" or BeanDoc, nor may "Tea", "TeaServlet",
34  * "Kettle", "Trove" or BeanDoc appear in their name, without prior written
35  * permission of GO.com.
36  *
37  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40  * DISCLAIMED. IN NO EVENT SHALL GO.COM OR ITS CONTRIBUTORS BE LIABLE
41  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
42  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
43  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
44  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
45  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
46  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
47  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
48  * ====================================================================
49  *
50  * For more information about Tea, please see http://opensource.go.com/.
51  */

52
53 package com.go.beandoc.teadoc;
54
55 import java.util.HashMap JavaDoc;
56 import java.util.Iterator JavaDoc;
57
58 /******************************************************************************
59  *
60  * @author Brian S O'Neill
61  * @version
62  * <!--$$Revision:--> 3 <!-- $-->, <!--$$JustDate:--> 8/23/00 <!-- $-->
63  */

64 public class RootDoc extends Doc implements com.sun.javadoc.DocErrorReporter {
65
66     private com.sun.javadoc.RootDoc mDoc;
67     private PackageDoc[] mPackages;
68
69     public RootDoc(com.sun.javadoc.RootDoc doc) {
70         super(null, doc);
71         mRootDoc = this;
72         mDoc = doc;
73     }
74
75     public String JavaDoc[][] getOptions() {
76         return mDoc.options();
77     }
78
79     public PackageDoc[] getSpecifiedPackages() {
80         return PackageDoc.convert(mRootDoc, mDoc.specifiedPackages());
81     }
82
83     public ClassDoc[] getSpecifiedClasses() {
84         return ClassDoc.convert(mRootDoc, mDoc.specifiedClasses());
85     }
86
87     public ClassDoc[] getClasses() {
88         return ClassDoc.convert(mRootDoc, mDoc.classes());
89     }
90
91     public PackageDoc[] getPackages() {
92         if (mPackages == null) {
93             ClassDoc[] classes = getClasses();
94             HashMap JavaDoc map = new HashMap JavaDoc();
95
96             for (int i=0; i<classes.length; i++) {
97                 PackageDoc doc = classes[i].getContainingPackage();
98                 map.put(doc.getName(), doc);
99             }
100
101             for (int i=0; i<classes.length; i++) {
102                 PackageDoc doc = classes[i].getContainingPackage();
103
104                 String JavaDoc[] path = doc.getPath();
105                 StringBuffer JavaDoc buf = new StringBuffer JavaDoc();
106                 String JavaDoc name = buf.toString();
107                 if (map.get(name) == null) {
108                     map.put(name, new EmptyPackageDoc(mRootDoc, name));
109                 }
110
111                 for (int j=0; j<path.length; j++) {
112                     if (j > 0) {
113                         buf.append('.');
114                     }
115                     buf.append(path[j]);
116                     name = buf.toString();
117                     if (map.get(name) == null) {
118                         map.put(name, new EmptyPackageDoc(mRootDoc, name));
119                     }
120                 }
121             }
122
123             mPackages = new PackageDoc[map.size()];
124             Iterator JavaDoc it = map.keySet().iterator();
125             int i = 0;
126             while (it.hasNext()) {
127                 mPackages[i++] = (PackageDoc)map.get(it.next());
128             }
129         }
130
131         return mPackages;
132     }
133
134     public void printError(String JavaDoc msg) {
135         mDoc.printError(msg);
136     }
137
138     public void printWarning(String JavaDoc msg) {
139         mDoc.printWarning(msg);
140     }
141
142     public void printNotice(String JavaDoc msg) {
143         mDoc.printNotice(msg);
144     }
145 }
146
Popular Tags