• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/classes/com/sun/tools/doclets/formats/html/markup/RawHtml.java@90af8d87741f (annotated)

src/share/classes/com/sun/tools/doclets/formats/html/markup/RawHtml.java

Wed, 01 Dec 2010 11:02:38 -0800

author

bpatel

date

Wed, 01 Dec 2010 11:02:38 -0800

changeset 766

90af8d87741f

child 1359

25e14ad23cef

permissions

-rw-r--r--

6851834: Javadoc doclet needs a structured approach to generate the output HTML.
Reviewed-by: jjg

bpatel@766	1	/*
bpatel@766	2	* Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
bpatel@766	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
bpatel@766	4	*
bpatel@766	5	* This code is free software; you can redistribute it and/or modify it
bpatel@766	6	* under the terms of the GNU General Public License version 2 only, as
bpatel@766	7	* published by the Free Software Foundation. Oracle designates this
bpatel@766	8	* particular file as subject to the "Classpath" exception as provided
bpatel@766	9	* by Oracle in the LICENSE file that accompanied this code.
bpatel@766	10	*
bpatel@766	11	* This code is distributed in the hope that it will be useful, but WITHOUT
bpatel@766	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
bpatel@766	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
bpatel@766	14	* version 2 for more details (a copy is included in the LICENSE file that
bpatel@766	15	* accompanied this code).
bpatel@766	16	*
bpatel@766	17	* You should have received a copy of the GNU General Public License version
bpatel@766	18	* 2 along with this work; if not, write to the Free Software Foundation,
bpatel@766	19	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
bpatel@766	20	*
bpatel@766	21	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
bpatel@766	22	* or visit www.oracle.com if you need additional information or have any
bpatel@766	23	* questions.
bpatel@766	24	*/
bpatel@766	25
bpatel@766	26	package com.sun.tools.doclets.formats.html.markup;
bpatel@766	27
bpatel@766	28	import com.sun.tools.doclets.internal.toolkit.Content;
bpatel@766	29	import com.sun.tools.doclets.internal.toolkit.util.*;
bpatel@766	30
bpatel@766	31	/**
bpatel@766	32	* Class for generating raw HTML content to be added to HTML pages of javadoc output.
bpatel@766	33	*
bpatel@766	34	* @author Bhavesh Patel
bpatel@766	35	*/
bpatel@766	36	public class RawHtml extends Content{
bpatel@766	37
bpatel@766	38	private String rawHtmlContent;
bpatel@766	39
bpatel@766	40	public static final Content nbsp = new RawHtml(" ");
bpatel@766	41
bpatel@766	42	/**
bpatel@766	43	* Constructor to construct a RawHtml object.
bpatel@766	44	*
bpatel@766	45	* @param rawHtml raw HTML text to be added
bpatel@766	46	*/
bpatel@766	47	public RawHtml(String rawHtml) {
bpatel@766	48	rawHtmlContent = nullCheck(rawHtml);
bpatel@766	49	}
bpatel@766	50
bpatel@766	51	/**
bpatel@766	52	* This method is not supported by the class.
bpatel@766	53	*
bpatel@766	54	* @param content content that needs to be added
bpatel@766	55	* @throws DocletAbortException this method will always throw a
bpatel@766	56	* DocletAbortException because it
bpatel@766	57	* is not supported.
bpatel@766	58	*/
bpatel@766	59	public void addContent(Content content) {
bpatel@766	60	throw new DocletAbortException();
bpatel@766	61	}
bpatel@766	62
bpatel@766	63	/**
bpatel@766	64	* This method is not supported by the class.
bpatel@766	65	*
bpatel@766	66	* @param stringContent string content that needs to be added
bpatel@766	67	* @throws DocletAbortException this method will always throw a
bpatel@766	68	* DocletAbortException because it
bpatel@766	69	* is not supported.
bpatel@766	70	*/
bpatel@766	71	public void addContent(String stringContent) {
bpatel@766	72	throw new DocletAbortException();
bpatel@766	73	}
bpatel@766	74
bpatel@766	75	/**
bpatel@766	76	* {@inheritDoc}
bpatel@766	77	*/
bpatel@766	78	public boolean isEmpty() {
bpatel@766	79	return rawHtmlContent.isEmpty();
bpatel@766	80	}
bpatel@766	81
bpatel@766	82	/**
bpatel@766	83	* {@inheritDoc}
bpatel@766	84	*/
bpatel@766	85	public void write(StringBuilder contentBuilder) {
bpatel@766	86	contentBuilder.append(rawHtmlContent);
bpatel@766	87	}
bpatel@766	88	}