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
|
/*
* Copyright (C) 2008 The Android Open Source Project
*
* 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.
*/
import com.sun.javadoc.*;
import com.sun.tools.doclets.*;
import org.clearsilver.HDF;
import org.clearsilver.CS;
import java.util.*;
import java.io.*;
public class PackageInfo extends DocInfo implements ContainerInfo
{
public static final Comparator<PackageInfo> comparator = new Comparator<PackageInfo>() {
public int compare(PackageInfo a, PackageInfo b) {
return a.name().compareTo(b.name());
}
};
public PackageInfo(PackageDoc pkg, String name, SourcePositionInfo position)
{
super(pkg.getRawCommentText(), position);
mName = name;
if (pkg == null) {
throw new RuntimeException("pkg is null");
}
mPackage = pkg;
}
public String htmlPage()
{
String s = mName;
s = s.replace('.', '/');
s += "/package-summary.html";
s = DroidDoc.javadocDir + s;
return s;
}
public String htmlLinksPage()
{
String s = mName;
s = s.replace('.', '/');
s += "/package-links.html";
s = DroidDoc.javadocDir + s;
return s;
}
public ContainerInfo parent()
{
return null;
}
public boolean isHidden()
{
return comment().isHidden();
}
public boolean checkLevel() {
// TODO should return false if all classes are hidden but the package isn't.
// We don't have this so I'm not doing it now.
return !isHidden();
}
public String name()
{
return mName;
}
public String qualifiedName()
{
return mName;
}
public TagInfo[] inlineTags()
{
return comment().tags();
}
public TagInfo[] firstSentenceTags()
{
return comment().briefTags();
}
public static ClassInfo[] filterHidden(ClassInfo[] classes)
{
ArrayList<ClassInfo> out = new ArrayList<ClassInfo>();
for (ClassInfo cl: classes) {
if (!cl.isHidden()) {
out.add(cl);
}
}
return out.toArray(new ClassInfo[0]);
}
public void makeLink(HDF data, String base)
{
if (checkLevel()) {
data.setValue(base + ".link", htmlPage());
}
data.setValue(base + ".name", name());
}
public void makeClassLinkListHDF(HDF data, String base)
{
makeLink(data, base);
ClassInfo.makeLinkListHDF(data, base + ".interfaces", ClassInfo.sortByName(interfaces()));
ClassInfo.makeLinkListHDF(data, base + ".classes", ClassInfo.sortByName(ordinaryClasses()));
ClassInfo.makeLinkListHDF(data, base + ".enums", ClassInfo.sortByName(enums()));
ClassInfo.makeLinkListHDF(data, base + ".exceptions", ClassInfo.sortByName(exceptions()));
ClassInfo.makeLinkListHDF(data, base + ".errors", ClassInfo.sortByName(errors()));
}
public ClassInfo[] interfaces()
{
return filterHidden(Converter.convertClasses(mPackage.interfaces()));
}
public ClassInfo[] ordinaryClasses()
{
return filterHidden(Converter.convertClasses(mPackage.ordinaryClasses()));
}
public ClassInfo[] enums()
{
return filterHidden(Converter.convertClasses(mPackage.enums()));
}
public ClassInfo[] exceptions()
{
return filterHidden(Converter.convertClasses(mPackage.exceptions()));
}
public ClassInfo[] errors()
{
return filterHidden(Converter.convertClasses(mPackage.errors()));
}
// in hashed containers, treat the name as the key
@Override
public int hashCode() {
return mName.hashCode();
}
private String mName;
private PackageDoc mPackage;
}
|
