1 /*
2 * Copyright (c) 2003, 2012, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 package com.sun.tools.doclets.internal.toolkit;
27
28 import com.sun.javadoc.*;
29 import com.sun.tools.doclets.internal.toolkit.util.*;
30
31 /**
32 * The interface for a factory creates writers.
33 *
34 * <p><b>This is NOT part of any supported API.
35 * If you write code that depends on this, you do so at your own risk.
36 * This code and its internal interfaces are subject to change or
37 * deletion without notice.</b>
38 *
39 * @author Jamie Ho
40 * @since 1.4
41 */
42
43 public interface WriterFactory {
44
45 /**
46 * Return the writer for the constant summary.
47 *
48 * @return the writer for the constant summary. Return null if this
49 * writer is not supported by the doclet.
50 */
51 public abstract ConstantsSummaryWriter getConstantsSummaryWriter()
52 throws Exception;
53
54 /**
55 * Return the writer for the package summary.
56 *
57 * @param packageDoc the package being documented.
58 * @param prevPkg the previous package that was documented.
59 * @param nextPkg the next package being documented.
60 * @return the writer for the package summary. Return null if this
61 * writer is not supported by the doclet.
62 */
63 public abstract PackageSummaryWriter getPackageSummaryWriter(PackageDoc
64 packageDoc, PackageDoc prevPkg, PackageDoc nextPkg)
65 throws Exception;
66
67 /**
68 * Return the writer for a class.
69 *
70 * @param classDoc the class being documented.
71 * @param prevClass the previous class that was documented.
72 * @param nextClass the next class being documented.
73 * @param classTree the class tree.
74 * @return the writer for the class. Return null if this
75 * writer is not supported by the doclet.
76 */
77 public abstract ClassWriter getClassWriter(ClassDoc classDoc,
78 ClassDoc prevClass, ClassDoc nextClass, ClassTree classTree)
79 throws Exception;
80
81 /**
82 * Return the writer for an annotation type.
83 *
84 * @param annotationType the type being documented.
85 * @param prevType the previous type that was documented.
|
1 /*
2 * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 package com.sun.tools.doclets.internal.toolkit;
27
28 import com.sun.javadoc.*;
29 import com.sun.tools.javac.jvm.Profile;
30 import com.sun.tools.doclets.internal.toolkit.util.*;
31
32 /**
33 * The interface for a factory creates writers.
34 *
35 * <p><b>This is NOT part of any supported API.
36 * If you write code that depends on this, you do so at your own risk.
37 * This code and its internal interfaces are subject to change or
38 * deletion without notice.</b>
39 *
40 * @author Jamie Ho
41 * @since 1.4
42 */
43
44 public interface WriterFactory {
45
46 /**
47 * Return the writer for the constant summary.
48 *
49 * @return the writer for the constant summary. Return null if this
50 * writer is not supported by the doclet.
51 */
52 public abstract ConstantsSummaryWriter getConstantsSummaryWriter()
53 throws Exception;
54
55 /**
56 * Return the writer for the package summary.
57 *
58 * @param packageDoc the package being documented.
59 * @param prevPkg the previous package that was documented.
60 * @param nextPkg the next package being documented.
61 * @return the writer for the package summary. Return null if this
62 * writer is not supported by the doclet.
63 */
64 public abstract PackageSummaryWriter getPackageSummaryWriter(PackageDoc
65 packageDoc, PackageDoc prevPkg, PackageDoc nextPkg)
66 throws Exception;
67
68 /**
69 * Return the writer for the profile summary.
70 *
71 * @param profile the profile being documented.
72 * @param prevProfile the previous profile that was documented.
73 * @param nextProfile the next profile being documented.
74 * @return the writer for the profile summary. Return null if this
75 * writer is not supported by the doclet.
76 */
77 public abstract ProfileSummaryWriter getProfileSummaryWriter(Profile
78 profile, Profile prevProfile, Profile nextProfile)
79 throws Exception;
80
81 /**
82 * Return the writer for the profile package summary.
83 *
84 * @param packageDoc the profile package being documented.
85 * @param prevPkg the previous profile package that was documented.
86 * @param nextPkg the next profile package being documented.
87 * @param profile the profile being documented.
88 * @return the writer for the profile package summary. Return null if this
89 * writer is not supported by the doclet.
90 */
91 public abstract ProfilePackageSummaryWriter getProfilePackageSummaryWriter(
92 PackageDoc packageDoc, PackageDoc prevPkg, PackageDoc nextPkg,
93 Profile profile) throws Exception;
94
95 /**
96 * Return the writer for a class.
97 *
98 * @param classDoc the class being documented.
99 * @param prevClass the previous class that was documented.
100 * @param nextClass the next class being documented.
101 * @param classTree the class tree.
102 * @return the writer for the class. Return null if this
103 * writer is not supported by the doclet.
104 */
105 public abstract ClassWriter getClassWriter(ClassDoc classDoc,
106 ClassDoc prevClass, ClassDoc nextClass, ClassTree classTree)
107 throws Exception;
108
109 /**
110 * Return the writer for an annotation type.
111 *
112 * @param annotationType the type being documented.
113 * @param prevType the previous type that was documented.
|