1/* 2 * Copyright (c) 2010, 2016, 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 */ 25 26package jdk.javadoc.internal.doclets.formats.html.markup; 27 28import java.io.IOException; 29import java.io.Writer; 30 31import jdk.javadoc.internal.doclets.toolkit.Content; 32import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants; 33 34/** 35 * Class for generating string content for HTML tags of javadoc output. 36 * 37 * <p><b>This is NOT part of any supported API. 38 * If you write code that depends on this, you do so at your own risk. 39 * This code and its internal interfaces are subject to change or 40 * deletion without notice.</b> 41 * 42 * @author Bhavesh Patel 43 */ 44public class StringContent extends Content { 45 46 private final StringBuilder stringContent; 47 48 /** 49 * Constructor to construct StringContent object. 50 */ 51 public StringContent() { 52 stringContent = new StringBuilder(); 53 } 54 55 /** 56 * Constructor to construct StringContent object with some initial content. 57 * 58 * @param initialContent initial content for the object 59 */ 60 public StringContent(CharSequence initialContent) { 61 stringContent = new StringBuilder(); 62 appendChars(initialContent); 63 } 64 65 /** 66 * This method is not supported by the class. 67 * 68 * @param content content that needs to be added 69 * @throws UnsupportedOperationException always 70 */ 71 @Override 72 public void addContent(Content content) { 73 throw new UnsupportedOperationException(); 74 } 75 76 /** 77 * Adds content for the StringContent object. The method escapes 78 * HTML characters for the string content that is added. 79 * 80 * @param strContent string content to be added 81 */ 82 @Override 83 public void addContent(CharSequence strContent) { 84 appendChars(strContent); 85 } 86 87 /** 88 * {@inheritDoc} 89 */ 90 @Override 91 public boolean isEmpty() { 92 return (stringContent.length() == 0); 93 } 94 95 @Override 96 public int charCount() { 97 return RawHtml.charCount(stringContent.toString()); 98 } 99 100 /** 101 * {@inheritDoc} 102 */ 103 @Override 104 public String toString() { 105 return stringContent.toString(); 106 } 107 108 /** 109 * {@inheritDoc} 110 */ 111 @Override 112 public boolean write(Writer out, boolean atNewline) throws IOException { 113 String s = stringContent.toString(); 114 out.write(s); 115 return s.endsWith(DocletConstants.NL); 116 } 117 118 private void appendChars(CharSequence s) { 119 for (int i = 0; i < s.length(); i++) { 120 char ch = s.charAt(i); 121 switch (ch) { 122 case '<': stringContent.append("<"); break; 123 case '>': stringContent.append(">"); break; 124 case '&': stringContent.append("&"); break; 125 default: stringContent.append(ch); break; 126 } 127 } 128 } 129} 130