Wed, 10 Oct 2012 16:48:21 -0700
8000665: fix "internal API" comments on javadoc files
Reviewed-by: darcy
1 /*
2 * Copyright (c) 2010, 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.markup;
28 import com.sun.tools.doclets.internal.toolkit.Content;
29 import com.sun.tools.doclets.internal.toolkit.util.*;
31 /**
32 * Class for generating raw HTML content to be added to HTML pages of javadoc output.
33 *
34 * <p><b>This is NOT part of any supported API.
35 * If you write code that depends on this, you do so at your own risk.
36 * This code and its internal interfaces are subject to change or
37 * deletion without notice.</b>
38 *
39 * @author Bhavesh Patel
40 */
41 public class RawHtml extends Content{
43 private String rawHtmlContent;
45 public static final Content nbsp = new RawHtml(" ");
47 /**
48 * Constructor to construct a RawHtml object.
49 *
50 * @param rawHtml raw HTML text to be added
51 */
52 public RawHtml(String rawHtml) {
53 rawHtmlContent = nullCheck(rawHtml);
54 }
56 /**
57 * This method is not supported by the class.
58 *
59 * @param content content that needs to be added
60 * @throws DocletAbortException this method will always throw a
61 * DocletAbortException because it
62 * is not supported.
63 */
64 public void addContent(Content content) {
65 throw new DocletAbortException();
66 }
68 /**
69 * This method is not supported by the class.
70 *
71 * @param stringContent string content that needs to be added
72 * @throws DocletAbortException this method will always throw a
73 * DocletAbortException because it
74 * is not supported.
75 */
76 public void addContent(String stringContent) {
77 throw new DocletAbortException();
78 }
80 /**
81 * {@inheritDoc}
82 */
83 public boolean isEmpty() {
84 return rawHtmlContent.isEmpty();
85 }
87 /**
88 * {@inheritDoc}
89 */
90 public void write(StringBuilder contentBuilder) {
91 contentBuilder.append(rawHtmlContent);
92 }
93 }