1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
/*
* Copyright (C) 2010 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.doclava;
import java.util.ArrayList;
public abstract class MemberInfo extends DocInfo implements Comparable, Scoped {
public MemberInfo(String rawCommentText, String name, String signature,
ClassInfo containingClass, ClassInfo realContainingClass, boolean isPublic,
boolean isProtected, boolean isPackagePrivate, boolean isPrivate, boolean isFinal,
boolean isStatic, boolean isSynthetic, String kind, SourcePositionInfo position,
ArrayList<AnnotationInstanceInfo> annotations) {
super(rawCommentText, position);
mName = name;
mSignature = signature;
mContainingClass = containingClass;
mRealContainingClass = realContainingClass;
mIsPublic = isPublic;
mIsProtected = isProtected;
mIsPackagePrivate = isPackagePrivate;
mIsPrivate = isPrivate;
mIsFinal = isFinal;
mIsStatic = isStatic;
mIsSynthetic = isSynthetic;
mKind = kind;
mAnnotations = annotations;
mShowAnnotations = AnnotationInstanceInfo.getShowAnnotationsIntersection(annotations);
mHideAnnotations = AnnotationInstanceInfo.getHideAnnotationsIntersection(annotations);
}
public abstract boolean isExecutable();
@Override
public boolean isHidden() {
if (mShowAnnotations.size() > 0) {
return false;
}
return super.isHidden() || mHideAnnotations.size() > 0;
}
@Override
public boolean isHiddenOrRemoved() {
return isHidden() || isRemoved();
}
public String anchor() {
if (mSignature != null) {
return mName + mSignature;
} else {
return mName;
}
}
public String htmlPage() {
return mContainingClass.htmlPage() + "#" + anchor();
}
public int compareTo(Object that) {
return this.htmlPage().compareTo(((MemberInfo) that).htmlPage());
}
public String name() {
return mName;
}
public String signature() {
return mSignature;
}
public ClassInfo realContainingClass() {
return mRealContainingClass;
}
public ClassInfo containingClass() {
return mContainingClass;
}
public boolean isPublic() {
return mIsPublic;
}
public boolean isProtected() {
return mIsProtected;
}
public boolean isPackagePrivate() {
return mIsPackagePrivate;
}
public boolean isPrivate() {
return mIsPrivate;
}
public String scope() {
if (isPublic()) {
return "public";
} else if (isProtected()) {
return "protected";
} else if (isPackagePrivate()) {
return "";
} else if (isPrivate()) {
return "private";
} else {
throw new RuntimeException("invalid scope for object " + this);
}
}
public boolean isStatic() {
return mIsStatic;
}
public boolean isFinal() {
return mIsFinal;
}
public boolean isSynthetic() {
return mIsSynthetic;
}
@Override
public ContainerInfo parent() {
return mContainingClass;
}
public boolean isCloned() {
return mContainingClass != mRealContainingClass;
}
/**
* Returns {@code true} if the member's scope is above the minimum requested scope passed to
* Doclava. Provided that the {@code -showAnnotationOverridesVisibility} argument was passed to
* Doclava, this will <emph>also</emph> return {@code true} if the member is tagged with an
* annotation which was specified in a {@code -showAnnotation} argument to Doclava
*/
public boolean checkLevel() {
if (Doclava.checkLevel(mIsPublic, mIsProtected, mIsPackagePrivate, mIsPrivate,
isHiddenOrRemoved())) {
return true;
} else if (Doclava.showAnnotationOverridesVisibility &&
mShowAnnotations != null && !mShowAnnotations.isEmpty()) {
return true;
}
return false;
}
public String kind() {
return mKind;
}
public ArrayList<AnnotationInstanceInfo> annotations() {
return mAnnotations;
}
public boolean hasShowAnnotation() {
return mShowAnnotations != null && mShowAnnotations.size() > 0;
}
public ArrayList<AnnotationInstanceInfo> showAnnotations() {
return mShowAnnotations;
}
public ArrayList<AnnotationInstanceInfo> hideAnnotations() {
return mHideAnnotations;
}
ClassInfo mContainingClass;
ClassInfo mRealContainingClass;
String mName;
String mSignature;
boolean mIsPublic;
boolean mIsProtected;
boolean mIsPackagePrivate;
boolean mIsPrivate;
boolean mIsFinal;
boolean mIsStatic;
boolean mIsSynthetic;
String mKind;
private ArrayList<AnnotationInstanceInfo> mAnnotations;
private ArrayList<AnnotationInstanceInfo> mShowAnnotations;
private ArrayList<AnnotationInstanceInfo> mHideAnnotations;
}
|
