author | hannesw |
Thu, 28 Jun 2018 01:46:03 +0200 | |
changeset 50856 | 1857ca5aca37 |
parent 50167 | cc705c956798 |
child 52695 | 99eb43bc3595 |
permissions | -rw-r--r-- |
33920 | 1 |
/* |
50167
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
47216
diff
changeset
|
2 |
* Copyright (c) 2015, 2018, Oracle and/or its affiliates. All rights reserved. |
33920 | 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 |
||
35426
374342e56a56
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33920
diff
changeset
|
26 |
package jdk.javadoc.internal.doclets.formats.html; |
33920 | 27 |
|
28 |
/** |
|
29 |
* Index item for search. |
|
30 |
* |
|
31 |
* <p><b>This is NOT part of any supported API. |
|
32 |
* If you write code that depends on this, you do so at your own risk. |
|
33 |
* This code and its internal interfaces are subject to change or |
|
34 |
* deletion without notice.</b> |
|
35 |
*/ |
|
36 |
public class SearchIndexItem { |
|
37 |
||
38 |
private String label = ""; |
|
39 |
private String url = ""; |
|
40 |
private String category = ""; |
|
40511 | 41 |
private String containingModule = ""; |
33920 | 42 |
private String containingPackage = ""; |
43 |
private String containingClass = ""; |
|
44 |
private String holder = ""; |
|
45 |
private String description = ""; |
|
46 |
||
47 |
public void setLabel(String l) { |
|
48 |
label = l; |
|
49 |
} |
|
50 |
||
51 |
public String getLabel() { |
|
52 |
return label; |
|
53 |
} |
|
54 |
||
55 |
public void setUrl(String u) { |
|
56 |
url = u; |
|
57 |
} |
|
58 |
||
59 |
public String getUrl() { |
|
60 |
return url; |
|
61 |
} |
|
62 |
||
40511 | 63 |
public void setContainingModule(String m) { |
64 |
containingModule = m; |
|
65 |
} |
|
66 |
||
33920 | 67 |
public void setContainingPackage(String p) { |
68 |
containingPackage = p; |
|
69 |
} |
|
70 |
||
71 |
public void setContainingClass(String c) { |
|
72 |
containingClass = c; |
|
73 |
} |
|
74 |
||
75 |
public void setCategory(String c) { |
|
76 |
category = c; |
|
77 |
} |
|
78 |
||
79 |
public void setHolder(String h) { |
|
80 |
holder = h; |
|
81 |
} |
|
82 |
||
83 |
public String getHolder() { |
|
84 |
return holder; |
|
85 |
} |
|
86 |
||
87 |
public void setDescription(String d) { |
|
88 |
description = d; |
|
89 |
} |
|
90 |
||
91 |
public String getDescription() { |
|
92 |
return description; |
|
93 |
} |
|
94 |
||
95 |
public String toString() { |
|
96 |
StringBuilder item = new StringBuilder(""); |
|
40511 | 97 |
if (category.equals("Modules")) { |
33920 | 98 |
item.append("{") |
99 |
.append("\"l\":\"").append(label).append("\"") |
|
100 |
.append("}"); |
|
40511 | 101 |
} else if (category.equals("Packages")) { |
102 |
item.append("{"); |
|
103 |
if (!containingModule.isEmpty()) { |
|
104 |
item.append("\"m\":\"").append(containingModule).append("\","); |
|
105 |
} |
|
50167
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
47216
diff
changeset
|
106 |
item.append("\"l\":\"").append(label).append("\""); |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
47216
diff
changeset
|
107 |
if (!url.equals("")) { |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
47216
diff
changeset
|
108 |
item.append(",\"url\":\"").append(url).append("\""); |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
47216
diff
changeset
|
109 |
} |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
47216
diff
changeset
|
110 |
item.append("}"); |
33920 | 111 |
} else if (category.equals("Types")) { |
50167
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
47216
diff
changeset
|
112 |
item.append("{"); |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
47216
diff
changeset
|
113 |
if (!containingPackage.equals("")) { |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
47216
diff
changeset
|
114 |
item.append("\"p\":\"").append(containingPackage).append("\","); |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
47216
diff
changeset
|
115 |
} |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
47216
diff
changeset
|
116 |
item.append("\"l\":\"").append(label).append("\""); |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
47216
diff
changeset
|
117 |
if (!url.equals("")) { |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
47216
diff
changeset
|
118 |
item.append(",\"url\":\"").append(url).append("\""); |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
47216
diff
changeset
|
119 |
} |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
47216
diff
changeset
|
120 |
item.append("}"); |
33920 | 121 |
} else if (category.equals("Members")) { |
122 |
item.append("{") |
|
123 |
.append("\"p\":\"").append(containingPackage).append("\",") |
|
124 |
.append("\"c\":\"").append(containingClass).append("\",") |
|
125 |
.append("\"l\":\"").append(label).append("\""); |
|
126 |
if (!url.equals("")) { |
|
127 |
item.append(",\"url\":\"").append(url).append("\""); |
|
128 |
} |
|
129 |
item.append("}"); |
|
130 |
} else { |
|
131 |
item.append("{") |
|
132 |
.append("\"l\":\"").append(label).append("\",") |
|
133 |
.append("\"h\":\"").append(holder).append("\","); |
|
134 |
if (!description.equals("")) { |
|
135 |
item.append("\"d\":\"").append(description).append("\","); |
|
136 |
} |
|
137 |
item.append("\"u\":\"").append(url).append("\"") |
|
138 |
.append("}"); |
|
139 |
} |
|
140 |
return item.toString(); |
|
141 |
} |
|
50856
1857ca5aca37
8190876: javadoc search on "java.se" shows "java.se" the last one among other modules
hannesw
parents:
50167
diff
changeset
|
142 |
|
1857ca5aca37
8190876: javadoc search on "java.se" shows "java.se" the last one among other modules
hannesw
parents:
50167
diff
changeset
|
143 |
/** |
1857ca5aca37
8190876: javadoc search on "java.se" shows "java.se" the last one among other modules
hannesw
parents:
50167
diff
changeset
|
144 |
* Get the part of the label after the last dot, or whole label if no dots. |
1857ca5aca37
8190876: javadoc search on "java.se" shows "java.se" the last one among other modules
hannesw
parents:
50167
diff
changeset
|
145 |
* |
1857ca5aca37
8190876: javadoc search on "java.se" shows "java.se" the last one among other modules
hannesw
parents:
50167
diff
changeset
|
146 |
* @return the simple name |
1857ca5aca37
8190876: javadoc search on "java.se" shows "java.se" the last one among other modules
hannesw
parents:
50167
diff
changeset
|
147 |
*/ |
1857ca5aca37
8190876: javadoc search on "java.se" shows "java.se" the last one among other modules
hannesw
parents:
50167
diff
changeset
|
148 |
public String getSimpleName() { |
1857ca5aca37
8190876: javadoc search on "java.se" shows "java.se" the last one among other modules
hannesw
parents:
50167
diff
changeset
|
149 |
return label.substring(label.lastIndexOf('.') + 1); |
1857ca5aca37
8190876: javadoc search on "java.se" shows "java.se" the last one among other modules
hannesw
parents:
50167
diff
changeset
|
150 |
} |
33920 | 151 |
} |