| /* |
| * Copyright (c) 2010, 2016, Oracle and/or its affiliates. All rights reserved. |
| * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| * |
| * This code is free software; you can redistribute it and/or modify it |
| * under the terms of the GNU General Public License version 2 only, as |
| * published by the Free Software Foundation. Oracle designates this |
| * particular file as subject to the "Classpath" exception as provided |
| * by Oracle in the LICENSE file that accompanied this code. |
| * |
| * This code is distributed in the hope that it will be useful, but WITHOUT |
| * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| * version 2 for more details (a copy is included in the LICENSE file that |
| * accompanied this code). |
| * |
| * You should have received a copy of the GNU General Public License version |
| * 2 along with this work; if not, write to the Free Software Foundation, |
| * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| * |
| * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| * or visit www.oracle.com if you need additional information or have any |
| * questions. |
| */ |
| |
| package jdk.javadoc.internal.doclets.formats.html.markup; |
| |
| import java.io.IOException; |
| import java.io.Writer; |
| |
| import jdk.javadoc.internal.doclets.toolkit.Content; |
| import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants; |
| |
| /** |
| * Class for generating string content for HTML tags of javadoc output. |
| * |
| * <p><b>This is NOT part of any supported API. |
| * If you write code that depends on this, you do so at your own risk. |
| * This code and its internal interfaces are subject to change or |
| * deletion without notice.</b> |
| * |
| * @author Bhavesh Patel |
| */ |
| public class StringContent extends Content { |
| |
| private final StringBuilder stringContent; |
| |
| /** |
| * Constructor to construct StringContent object. |
| */ |
| public StringContent() { |
| stringContent = new StringBuilder(); |
| } |
| |
| /** |
| * Constructor to construct StringContent object with some initial content. |
| * |
| * @param initialContent initial content for the object |
| */ |
| public StringContent(CharSequence initialContent) { |
| stringContent = new StringBuilder(); |
| appendChars(initialContent); |
| } |
| |
| /** |
| * This method is not supported by the class. |
| * |
| * @param content content that needs to be added |
| * @throws UnsupportedOperationException always |
| */ |
| @Override |
| public void addContent(Content content) { |
| throw new UnsupportedOperationException(); |
| } |
| |
| /** |
| * Adds content for the StringContent object. The method escapes |
| * HTML characters for the string content that is added. |
| * |
| * @param strContent string content to be added |
| */ |
| @Override |
| public void addContent(CharSequence strContent) { |
| appendChars(strContent); |
| } |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public boolean isEmpty() { |
| return (stringContent.length() == 0); |
| } |
| |
| @Override |
| public int charCount() { |
| return RawHtml.charCount(stringContent.toString()); |
| } |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public String toString() { |
| return stringContent.toString(); |
| } |
| |
| /** |
| * {@inheritDoc} |
| */ |
| @Override |
| public boolean write(Writer out, boolean atNewline) throws IOException { |
| String s = stringContent.toString(); |
| out.write(s); |
| return s.endsWith(DocletConstants.NL); |
| } |
| |
| private void appendChars(CharSequence s) { |
| for (int i = 0; i < s.length(); i++) { |
| char ch = s.charAt(i); |
| switch (ch) { |
| case '<': stringContent.append("<"); break; |
| case '>': stringContent.append(">"); break; |
| case '&': stringContent.append("&"); break; |
| default: stringContent.append(ch); break; |
| } |
| } |
| } |
| } |