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.builders;
27
28 import java.util.HashSet;
29 import java.util.Set;
30
31 import com.sun.javadoc.*;
32 import com.sun.tools.doclets.internal.toolkit.*;
33 import com.sun.tools.doclets.internal.toolkit.util.*;
34
35 /**
36 * The factory for constructing builders.
37 *
38 * <p><b>This is NOT part of any supported API.
39 * If you write code that depends on this, you do so at your own risk.
40 * This code and its internal interfaces are subject to change or
41 * deletion without notice.</b>
42 *
43 * @author Jamie Ho
44 * @since 1.4
45 */
46
47 public class BuilderFactory {
48
49 /**
50 * The current configuration of the doclet.
51 */
76 * Return the builder that builds the constant summary.
77 * @return the builder that builds the constant summary.
78 */
79 public AbstractBuilder getConstantsSummaryBuider() throws Exception {
80 return ConstantsSummaryBuilder.getInstance(context,
81 writerFactory.getConstantsSummaryWriter());
82 }
83
84 /**
85 * Return the builder that builds the package summary.
86 *
87 * @param pkg the package being documented.
88 * @param prevPkg the previous package being documented.
89 * @param nextPkg the next package being documented.
90 * @return the builder that builds the constant summary.
91 */
92 public AbstractBuilder getPackageSummaryBuilder(PackageDoc pkg, PackageDoc prevPkg,
93 PackageDoc nextPkg) throws Exception {
94 return PackageSummaryBuilder.getInstance(context, pkg,
95 writerFactory.getPackageSummaryWriter(pkg, prevPkg, nextPkg));
96 }
97
98 /**
99 * Return the builder for the class.
100 *
101 * @param classDoc the class being documented.
102 * @param prevClass the previous class that was documented.
103 * @param nextClass the next class being documented.
104 * @param classTree the class tree.
105 * @return the writer for the class. Return null if this
106 * writer is not supported by the doclet.
107 */
108 public AbstractBuilder getClassBuilder(ClassDoc classDoc,
109 ClassDoc prevClass, ClassDoc nextClass, ClassTree classTree)
110 throws Exception {
111 return ClassBuilder.getInstance(context, classDoc,
112 writerFactory.getClassWriter(classDoc, prevClass, nextClass,
113 classTree));
114 }
115
|
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.builders;
27
28 import java.util.HashSet;
29 import java.util.Set;
30
31 import com.sun.javadoc.*;
32 import com.sun.tools.javac.jvm.Profile;
33 import com.sun.tools.doclets.internal.toolkit.*;
34 import com.sun.tools.doclets.internal.toolkit.util.*;
35
36 /**
37 * The factory for constructing builders.
38 *
39 * <p><b>This is NOT part of any supported API.
40 * If you write code that depends on this, you do so at your own risk.
41 * This code and its internal interfaces are subject to change or
42 * deletion without notice.</b>
43 *
44 * @author Jamie Ho
45 * @since 1.4
46 */
47
48 public class BuilderFactory {
49
50 /**
51 * The current configuration of the doclet.
52 */
77 * Return the builder that builds the constant summary.
78 * @return the builder that builds the constant summary.
79 */
80 public AbstractBuilder getConstantsSummaryBuider() throws Exception {
81 return ConstantsSummaryBuilder.getInstance(context,
82 writerFactory.getConstantsSummaryWriter());
83 }
84
85 /**
86 * Return the builder that builds the package summary.
87 *
88 * @param pkg the package being documented.
89 * @param prevPkg the previous package being documented.
90 * @param nextPkg the next package being documented.
91 * @return the builder that builds the constant summary.
92 */
93 public AbstractBuilder getPackageSummaryBuilder(PackageDoc pkg, PackageDoc prevPkg,
94 PackageDoc nextPkg) throws Exception {
95 return PackageSummaryBuilder.getInstance(context, pkg,
96 writerFactory.getPackageSummaryWriter(pkg, prevPkg, nextPkg));
97 }
98
99 /**
100 * Return the builder that builds the profile summary.
101 *
102 * @param profile the profile being documented.
103 * @param prevProfile the previous profile being documented.
104 * @param nextProfile the next profile being documented.
105 * @return the builder that builds the profile summary.
106 */
107 public AbstractBuilder getProfileSummaryBuilder(Profile profile, Profile prevProfile,
108 Profile nextProfile) throws Exception {
109 return ProfileSummaryBuilder.getInstance(context, profile,
110 writerFactory.getProfileSummaryWriter(profile, prevProfile, nextProfile));
111 }
112
113 /**
114 * Return the builder that builds the profile package summary.
115 *
116 * @param pkg the profile package being documented.
117 * @param prevPkg the previous profile package being documented.
118 * @param nextPkg the next profile package being documented.
119 * @param profile the profile being documented.
120 * @return the builder that builds the profile package summary.
121 */
122 public AbstractBuilder getProfilePackageSummaryBuilder(PackageDoc pkg, PackageDoc prevPkg,
123 PackageDoc nextPkg, Profile profile) throws Exception {
124 return ProfilePackageSummaryBuilder.getInstance(context, pkg,
125 writerFactory.getProfilePackageSummaryWriter(pkg, prevPkg, nextPkg,
126 profile), profile);
127 }
128
129 /**
130 * Return the builder for the class.
131 *
132 * @param classDoc the class being documented.
133 * @param prevClass the previous class that was documented.
134 * @param nextClass the next class being documented.
135 * @param classTree the class tree.
136 * @return the writer for the class. Return null if this
137 * writer is not supported by the doclet.
138 */
139 public AbstractBuilder getClassBuilder(ClassDoc classDoc,
140 ClassDoc prevClass, ClassDoc nextClass, ClassTree classTree)
141 throws Exception {
142 return ClassBuilder.getInstance(context, classDoc,
143 writerFactory.getClassWriter(classDoc, prevClass, nextClass,
144 classTree));
145 }
146
|