Wed, 10 Oct 2012 16:48:21 -0700
8000665: fix "internal API" comments on javadoc files
Reviewed-by: darcy
1 /*
2 * Copyright (c) 1998, 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 */
26 package com.sun.tools.doclets.formats.html;
28 import java.io.*;
30 import com.sun.tools.doclets.formats.html.markup.*;
31 import com.sun.tools.doclets.internal.toolkit.*;
32 import com.sun.tools.doclets.internal.toolkit.util.*;
34 /**
35 * Generate Separate Index Files for all the member names with Indexing in
36 * Unicode Order. This will create "index-files" directory in the current or
37 * destination directory and will generate separate file for each unicode index.
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 * @see java.lang.Character
45 * @author Atul M Dambalkar
46 * @author Bhavesh Patel (Modified)
47 */
48 public class SplitIndexWriter extends AbstractIndexWriter {
50 /**
51 * Previous unicode character index in the built index.
52 */
53 protected int prev;
55 /**
56 * Next unicode character in the built index.
57 */
58 protected int next;
60 /**
61 * Construct the SplitIndexWriter. Uses path to this file and relative path
62 * from this file.
63 *
64 * @param path Path to the file which is getting generated.
65 * @param filename Name of the file which is getting genrated.
66 * @param relpath Relative path from this file to the current directory.
67 * @param indexbuilder Unicode based Index from {@link IndexBuilder}
68 */
69 public SplitIndexWriter(ConfigurationImpl configuration,
70 String path, String filename,
71 String relpath, IndexBuilder indexbuilder,
72 int prev, int next) throws IOException {
73 super(configuration, path, filename, relpath, indexbuilder);
74 this.prev = prev;
75 this.next = next;
76 }
78 /**
79 * Generate separate index files, for each Unicode character, listing all
80 * the members starting with the particular unicode character.
81 *
82 * @param indexbuilder IndexBuilder built by {@link IndexBuilder}
83 * @throws DocletAbortException
84 */
85 public static void generate(ConfigurationImpl configuration,
86 IndexBuilder indexbuilder) {
87 SplitIndexWriter indexgen;
88 String filename = "";
89 String path = DirectoryManager.getPath("index-files");
90 String relpath = DirectoryManager.getRelativePath("index-files");
91 try {
92 for (int i = 0; i < indexbuilder.elements().length; i++) {
93 int j = i + 1;
94 int prev = (j == 1)? -1: i;
95 int next = (j == indexbuilder.elements().length)? -1: j + 1;
96 filename = "index-" + j +".html";
97 indexgen = new SplitIndexWriter(configuration,
98 path, filename, relpath,
99 indexbuilder, prev, next);
100 indexgen.generateIndexFile((Character)indexbuilder.
101 elements()[i]);
102 indexgen.close();
103 }
104 } catch (IOException exc) {
105 configuration.standardmessage.error(
106 "doclet.exception_encountered",
107 exc.toString(), filename);
108 throw new DocletAbortException();
109 }
110 }
112 /**
113 * Generate the contents of each index file, with Header, Footer,
114 * Member Field, Method and Constructor Description.
115 *
116 * @param unicode Unicode character referring to the character for the
117 * index.
118 */
119 protected void generateIndexFile(Character unicode) throws IOException {
120 String title = configuration.getText("doclet.Window_Split_Index",
121 unicode.toString());
122 Content body = getBody(true, getWindowTitle(title));
123 addTop(body);
124 addNavLinks(true, body);
125 HtmlTree divTree = new HtmlTree(HtmlTag.DIV);
126 divTree.addStyle(HtmlStyle.contentContainer);
127 addLinksForIndexes(divTree);
128 addContents(unicode, indexbuilder.getMemberList(unicode), divTree);
129 addLinksForIndexes(divTree);
130 body.addContent(divTree);
131 addNavLinks(false, body);
132 addBottom(body);
133 printHtmlDocument(null, true, body);
134 }
136 /**
137 * Add links for all the Index Files per unicode character.
138 *
139 * @param contentTree the content tree to which the links for indexes will be added
140 */
141 protected void addLinksForIndexes(Content contentTree) {
142 Object[] unicodeChars = indexbuilder.elements();
143 for (int i = 0; i < unicodeChars.length; i++) {
144 int j = i + 1;
145 contentTree.addContent(getHyperLink("index-" + j + ".html",
146 new StringContent(unicodeChars[i].toString())));
147 contentTree.addContent(getSpace());
148 }
149 }
151 /**
152 * Get link to the previous unicode character.
153 *
154 * @return a content tree for the link
155 */
156 public Content getNavLinkPrevious() {
157 Content prevletterLabel = getResource("doclet.Prev_Letter");
158 if (prev == -1) {
159 return HtmlTree.LI(prevletterLabel);
160 }
161 else {
162 Content prevLink = getHyperLink("index-" + prev + ".html", "",
163 prevletterLabel);
164 return HtmlTree.LI(prevLink);
165 }
166 }
168 /**
169 * Get link to the next unicode character.
170 *
171 * @return a content tree for the link
172 */
173 public Content getNavLinkNext() {
174 Content nextletterLabel = getResource("doclet.Next_Letter");
175 if (next == -1) {
176 return HtmlTree.LI(nextletterLabel);
177 }
178 else {
179 Content nextLink = getHyperLink("index-" + next + ".html","",
180 nextletterLabel);
181 return HtmlTree.LI(nextLink);
182 }
183 }
184 }