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