KickJava   Java API By Example, From Geeks To Geeks.

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


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 PackageFrameWriter
31     extends com.sun.tools.doclets.standard.PackageFrameWriter
32 {
33
34     protected final PackageDoc packagedoc;
35
36     public PackageFrameWriter(String JavaDoc path,
37                               String JavaDoc filename,
38                               PackageDoc packagedoc)
39         throws IOException JavaDoc, DocletAbortException {
40         super(path, filename, packagedoc);
41         this.packagedoc = packagedoc;
42     }
43
44     public static void generate(PackageDoc pkg) throws DocletAbortException {
45         PackageFrameWriter pw = null;
46         String JavaDoc path = DirectoryManager.getDirectoryPath(pkg);
47         String JavaDoc filename = "package-frame" + ".html";
48         try {
49             (pw = new PackageFrameWriter(path, filename, pkg)).
50                 generatePackageFile();
51         } catch (IOException JavaDoc e) {
52             Standard.configuration().standardmessage.
53                     error("doclet.exception_encountered",
54                            e+"", filename);
55             throw new DocletAbortException();
56         } finally {
57             if (pw != null) pw.close();
58         }
59     }
60
61     protected void generateClassListing() {
62         generateClassKindListing(packagedoc.interfaces(),
63                                  getText("doclet.Interfaces"));
64         generateClassKindListing(Statics.classes(packagedoc.
65                                                  ordinaryClasses()),
66                                  getText("doclet.Classes"));
67         generateClassKindListing(((org.aspectj.ajdoc.PackageDoc)packagedoc).
68                                  aspects(),
69                                  getText("doclet.Aspects"));
70         generateClassKindListing(packagedoc.exceptions(),
71                                  getText("doclet.Exceptions"));
72         generateClassKindListing(packagedoc.errors(),
73                                  getText("doclet.Errors"));
74     }
75 }
76
Popular Tags