author | ksrini |
Tue, 24 Apr 2018 11:54:03 -0700 | |
changeset 49879 | 601277b1d582 |
parent 47216 | 71c04702a3d5 |
permissions | -rw-r--r-- |
10 | 1 |
/* |
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
47216
diff
changeset
|
2 |
* Copyright (c) 2003, 2018, Oracle and/or its affiliates. All rights reserved. |
10 | 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 |
|
5520 | 7 |
* published by the Free Software Foundation. Oracle designates this |
10 | 8 |
* particular file as subject to the "Classpath" exception as provided |
5520 | 9 |
* by Oracle in the LICENSE file that accompanied this code. |
10 | 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 |
* |
|
5520 | 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. |
|
10 | 24 |
*/ |
25 |
||
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
25874
diff
changeset
|
26 |
package jdk.javadoc.internal.doclets.toolkit.builders; |
10 | 27 |
|
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
47216
diff
changeset
|
28 |
import java.util.List; |
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
47216
diff
changeset
|
29 |
import javax.lang.model.element.Element; |
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
47216
diff
changeset
|
30 |
import javax.lang.model.element.TypeElement; |
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
47216
diff
changeset
|
31 |
|
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
25874
diff
changeset
|
32 |
import jdk.javadoc.internal.doclets.toolkit.Content; |
40587 | 33 |
import jdk.javadoc.internal.doclets.toolkit.DocletException; |
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
47216
diff
changeset
|
34 |
import jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable; |
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
47216
diff
changeset
|
35 |
import jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable.Kind; |
10 | 36 |
|
37 |
/** |
|
38 |
* The superclass for all member builders. Member builders are only executed |
|
39 |
* within Class Builders. They essentially build sub-components. For example, |
|
40 |
* method documentation is a sub-component of class documentation. |
|
41 |
* |
|
14260
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
42 |
* <p><b>This is NOT part of any supported API. |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
43 |
* If you write code that depends on this, you do so at your own risk. |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
44 |
* This code and its internal interfaces are subject to change or |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
45 |
* deletion without notice.</b> |
10 | 46 |
* |
47 |
* @author Jamie Ho |
|
48 |
*/ |
|
49 |
public abstract class AbstractMemberBuilder extends AbstractBuilder { |
|
50 |
||
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
47216
diff
changeset
|
51 |
final protected TypeElement typeElement; |
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
47216
diff
changeset
|
52 |
|
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
47216
diff
changeset
|
53 |
final protected VisibleMemberTable visibleMemberTable; |
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
47216
diff
changeset
|
54 |
|
10 | 55 |
/** |
56 |
* Construct a SubBuilder. |
|
40587 | 57 |
* @param context a context object, providing information used in this run |
10 | 58 |
* of the doclet. |
59 |
*/ |
|
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
47216
diff
changeset
|
60 |
public AbstractMemberBuilder(Context context, TypeElement typeElement) { |
14542 | 61 |
super(context); |
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
47216
diff
changeset
|
62 |
this.typeElement = typeElement; |
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
47216
diff
changeset
|
63 |
visibleMemberTable = configuration.getVisibleMemberTable(typeElement); |
10 | 64 |
} |
65 |
||
66 |
/** |
|
67 |
* This method is not supported by sub-builders. |
|
68 |
* |
|
40587 | 69 |
* @throws AssertionError always |
10 | 70 |
*/ |
40587 | 71 |
@Override |
72 |
public void build() { |
|
73 |
// You may not call the build method in a subbuilder. |
|
74 |
throw new AssertionError(); |
|
10 | 75 |
} |
76 |
||
77 |
/** |
|
45599 | 78 |
* |
79 |
* Build the documentation. |
|
10 | 80 |
* |
45599 | 81 |
* @param contentTree The content tree into which to add the documention |
82 |
* @throws DocletException if there is a problem building the documentation |
|
10 | 83 |
*/ |
45599 | 84 |
public abstract void build(Content contentTree) throws DocletException; |
10 | 85 |
|
86 |
/** |
|
40587 | 87 |
* Returns true if this subbuilder has anything to document. |
10 | 88 |
* |
40587 | 89 |
* @return true if this subbuilder has anything to document |
10 | 90 |
*/ |
91 |
public abstract boolean hasMembersToDocument(); |
|
49879
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
47216
diff
changeset
|
92 |
|
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
47216
diff
changeset
|
93 |
/** |
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
47216
diff
changeset
|
94 |
* Returns a list of visible elements of the specified kind in this |
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
47216
diff
changeset
|
95 |
* type element. |
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
47216
diff
changeset
|
96 |
* @param kind of members |
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
47216
diff
changeset
|
97 |
* @return a list of members |
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
47216
diff
changeset
|
98 |
*/ |
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
47216
diff
changeset
|
99 |
protected List<? extends Element> getVisibleMembers(Kind kind) { |
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
47216
diff
changeset
|
100 |
return visibleMemberTable.getVisibleMembers(kind); |
601277b1d582
8025091: VisibleMemberMap.java possible performance improvements
ksrini
parents:
47216
diff
changeset
|
101 |
} |
10 | 102 |
} |