KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > aspectj > tools > doclets > standard > PackageWriter


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.doclets.standard;
23
24 import com.sun.javadoc.PackageDoc;
25 import com.sun.tools.doclets.DirectoryManager;
26 import com.sun.tools.doclets.DocletAbortException;
27
28 import java.io.IOException JavaDoc;
29
30 public class PackageWriter
31     extends com.sun.tools.doclets.standard.PackageWriter
32 {
33
34     protected final PackageDoc packagedoc;
35
36     public PackageWriter(String JavaDoc path,
37                          String JavaDoc filename,
38                          PackageDoc packagedoc,
39                          PackageDoc prev,
40                          PackageDoc next)
41         throws IOException JavaDoc, DocletAbortException {
42         super(path, filename, packagedoc, prev, next);
43         this.packagedoc = packagedoc;
44     }
45
46     public static void generate(PackageDoc pkg,
47                                 PackageDoc prev,
48                                 PackageDoc next) throws DocletAbortException {
49         PackageWriter pw;
50         String JavaDoc path = DirectoryManager.getDirectoryPath(pkg);
51         String JavaDoc filename = "package-summary.html";
52         try {
53             (pw = new PackageWriter(path, filename, pkg, prev, next)).
54                 generatePackageFile();
55             pw.close();
56             pw.copyDocFiles(path);
57         } catch (IOException JavaDoc e) {
58             Standard.configuration().standardmessage.
59                 error("doclet.exception_encountered", e+"", filename);
60             throw new DocletAbortException();
61         }
62     }
63
64     protected void generateClassListing() {
65         generateClassKindListing(packagedoc.interfaces(),
66                                  getText("doclet.Interface_Summary"));
67         generateClassKindListing(Statics.classes(packagedoc.ordinaryClasses()),
68                                    getText("doclet.Class_Summary"));
69         generateClassKindListing(((org.aspectj.ajdoc.PackageDoc)packagedoc).aspects(),
70                                  getText("doclet.Aspect_Summary"));
71         generateClassKindListing(packagedoc.exceptions(),
72                                  getText("doclet.Exception_Summary"));
73         generateClassKindListing(packagedoc.errors(),
74                                  getText("doclet.Error_Summary"));
75     }
76 }
77
78
79
80
Popular Tags