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

src/share/classes/com/sun/tools/doclets/formats/html/markup/StringContent.java@ca5783d9a597 (annotated)

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

Mon, 16 Oct 2017 16:07:48 +0800

author

aoqi

date

Mon, 16 Oct 2017 16:07:48 +0800

changeset 2893

ca5783d9a597

parent 2525

2eb010b6cb22

permissions

-rw-r--r--

merge

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0	4	*
aoqi@0	5	* This code is free software; you can redistribute it and/or modify it
aoqi@0	6	* under the terms of the GNU General Public License version 2 only, as
aoqi@0	7	* published by the Free Software Foundation. Oracle designates this
aoqi@0	8	* particular file as subject to the "Classpath" exception as provided
aoqi@0	9	* by Oracle in the LICENSE file that accompanied this code.
aoqi@0	10	*
aoqi@0	11	* This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0	14	* version 2 for more details (a copy is included in the LICENSE file that
aoqi@0	15	* accompanied this code).
aoqi@0	16	*
aoqi@0	17	* You should have received a copy of the GNU General Public License version
aoqi@0	18	* 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0	19	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0	20	*
aoqi@0	21	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0	22	* or visit www.oracle.com if you need additional information or have any
aoqi@0	23	* questions.
aoqi@0	24	*/
aoqi@0	25
aoqi@0	26	package com.sun.tools.doclets.formats.html.markup;
aoqi@0	27
aoqi@0	28	import java.io.IOException;
aoqi@0	29	import java.io.Writer;
aoqi@0	30
aoqi@0	31	import com.sun.tools.doclets.internal.toolkit.Content;
aoqi@0	32	import com.sun.tools.doclets.internal.toolkit.util.*;
aoqi@0	33
aoqi@0	34	/**
aoqi@0	35	* Class for generating string content for HTML tags of javadoc output.
aoqi@0	36	*
aoqi@0	37	* <p><b>This is NOT part of any supported API.
aoqi@0	38	* If you write code that depends on this, you do so at your own risk.
aoqi@0	39	* This code and its internal interfaces are subject to change or
aoqi@0	40	* deletion without notice.</b>
aoqi@0	41	*
aoqi@0	42	* @author Bhavesh Patel
aoqi@0	43	*/
aoqi@0	44	public class StringContent extends Content {
aoqi@0	45
aoqi@0	46	private StringBuilder stringContent;
aoqi@0	47
aoqi@0	48	/**
aoqi@0	49	* Constructor to construct StringContent object.
aoqi@0	50	*/
aoqi@0	51	public StringContent() {
aoqi@0	52	stringContent = new StringBuilder();
aoqi@0	53	}
aoqi@0	54
aoqi@0	55	/**
aoqi@0	56	* Constructor to construct StringContent object with some initial content.
aoqi@0	57	*
aoqi@0	58	* @param initialContent initial content for the object
aoqi@0	59	*/
aoqi@0	60	public StringContent(String initialContent) {
aoqi@0	61	stringContent = new StringBuilder();
aoqi@0	62	appendChars(initialContent);
aoqi@0	63	}
aoqi@0	64
aoqi@0	65	/**
aoqi@0	66	* This method is not supported by the class.
aoqi@0	67	*
aoqi@0	68	* @param content content that needs to be added
aoqi@0	69	* @throws DocletAbortException this method will always throw a
aoqi@0	70	* DocletAbortException because it
aoqi@0	71	* is not supported.
aoqi@0	72	*/
aoqi@0	73	@Override
aoqi@0	74	public void addContent(Content content) {
aoqi@0	75	throw new DocletAbortException("not supported");
aoqi@0	76	}
aoqi@0	77
aoqi@0	78	/**
aoqi@0	79	* Adds content for the StringContent object. The method escapes
aoqi@0	80	* HTML characters for the string content that is added.
aoqi@0	81	*
aoqi@0	82	* @param strContent string content to be added
aoqi@0	83	*/
aoqi@0	84	@Override
aoqi@0	85	public void addContent(String strContent) {
aoqi@0	86	appendChars(strContent);
aoqi@0	87	}
aoqi@0	88
aoqi@0	89	/**
aoqi@0	90	* {@inheritDoc}
aoqi@0	91	*/
aoqi@0	92	@Override
aoqi@0	93	public boolean isEmpty() {
aoqi@0	94	return (stringContent.length() == 0);
aoqi@0	95	}
aoqi@0	96
aoqi@0	97	@Override
aoqi@0	98	public int charCount() {
aoqi@0	99	return RawHtml.charCount(stringContent.toString());
aoqi@0	100	}
aoqi@0	101
aoqi@0	102	/**
aoqi@0	103	* {@inheritDoc}
aoqi@0	104	*/
aoqi@0	105	@Override
aoqi@0	106	public String toString() {
aoqi@0	107	return stringContent.toString();
aoqi@0	108	}
aoqi@0	109
aoqi@0	110	/**
aoqi@0	111	* {@inheritDoc}
aoqi@0	112	*/
aoqi@0	113	@Override
aoqi@0	114	public boolean write(Writer out, boolean atNewline) throws IOException {
aoqi@0	115	String s = stringContent.toString();
aoqi@0	116	out.write(s);
aoqi@0	117	return s.endsWith(DocletConstants.NL);
aoqi@0	118	}
aoqi@0	119
aoqi@0	120	private void appendChars(String s) {
aoqi@0	121	for (int i = 0; i < s.length(); i++) {
aoqi@0	122	char ch = s.charAt(i);
aoqi@0	123	switch (ch) {
aoqi@0	124	case '<': stringContent.append("&lt;"); break;
aoqi@0	125	case '>': stringContent.append("&gt;"); break;
aoqi@0	126	case '&': stringContent.append("&amp;"); break;
aoqi@0	127	default: stringContent.append(ch); break;
aoqi@0	128	}
aoqi@0	129	}
aoqi@0	130	}
aoqi@0	131	}