jdk8-mips64-public/langtools: src/share/classes/com/sun/tools/doclets/formats/html/markup/StringContent.java@6f0746b6de9f

     1 /*

     2  * Copyright (c) 2010, 2013, 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  */

    26 package com.sun.tools.doclets.formats.html.markup;

    28 import java.io.IOException;

    29 import java.io.Writer;

    31 import com.sun.tools.doclets.internal.toolkit.Content;

    32 import com.sun.tools.doclets.internal.toolkit.util.*;

    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  */

    44 public class StringContent extends Content {

    46     private StringBuilder stringContent;

    48     /**

    49      * Constructor to construct StringContent object.

    50      */

    51     public StringContent() {

    52         stringContent = new StringBuilder();

    53     }

    55     /**

    56      * Constructor to construct StringContent object with some initial content.

    57      *

    58      * @param initialContent initial content for the object

    59      */

    60     public StringContent(String initialContent) {

    61         stringContent = new StringBuilder();

    62         appendChars(initialContent);

    63     }

    65     /**

    66      * This method is not supported by the class.

    67      *

    68      * @param content content that needs to be added

    69      * @throws DocletAbortException this method will always throw a

    70      *                              DocletAbortException because it

    71      *                              is not supported.

    72      */

    73     @Override

    74     public void addContent(Content content) {

    75         throw new DocletAbortException("not supported");

    76     }

    78     /**

    79      * Adds content for the StringContent object.  The method escapes

    80      * HTML characters for the string content that is added.

    81      *

    82      * @param strContent string content to be added

    83      */

    84     @Override

    85     public void addContent(String strContent) {

    86         appendChars(strContent);

    87     }

    89     /**

    90      * {@inheritDoc}

    91      */

    92     @Override

    93     public boolean isEmpty() {

    94         return (stringContent.length() == 0);

    95     }

    97     @Override

    98     public int charCount() {

    99         return RawHtml.charCount(stringContent.toString());

   100     }

   102     /**

   103      * {@inheritDoc}

   104      */

   105     @Override

   106     public String toString() {

   107         return stringContent.toString();

   108     }

   110     /**

   111      * {@inheritDoc}

   112      */

   113     @Override

   114     public boolean write(Writer out, boolean atNewline) throws IOException {

   115         String s = stringContent.toString();

   116         out.write(s);

   117         return s.endsWith(DocletConstants.NL);

   118     }

   120     private void appendChars(String s) {

   121         for (int i = 0; i < s.length(); i++) {

   122             char ch = s.charAt(i);

   123             switch (ch) {

   124                 case '<': stringContent.append("&lt;");  break;

   125                 case '>': stringContent.append("&gt;");  break;

   126                 case '&': stringContent.append("&amp;"); break;

   127                 default:  stringContent.append(ch);      break;

   128             }

   129         }

   130     }

   131 }

Mercurial > jdk8-mips64-public > langtools / file revision