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

     1 /*

     2  * Copyright (c) 2010, 2012, 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                 Util.escapeHtmlChars(nullCheck(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     public void addContent(Content content) {

    74         throw new DocletAbortException();

    75     }

    77     /**

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

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

    80      *

    81      * @param strContent string content to be added

    82      */

    83     public void addContent(String strContent) {

    84         stringContent.append(Util.escapeHtmlChars(nullCheck(strContent)));

    85     }

    87     /**

    88      * {@inheritDoc}

    89      */

    90     public boolean isEmpty() {

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

    92     }

    94     /**

    95      * {@inheritDoc}

    96      */

    97     public String toString() {

    98         return stringContent.toString();

    99     }

   101     /**

   102      * {@inheritDoc}

   103      */

   104     @Override

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

   106         String s = stringContent.toString();

   107         out.write(s);

   108         return s.endsWith(DocletConstants.NL);

   109     }

   110 }

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