src/share/classes/com/sun/tools/doclets/formats/html/TagletOutputImpl.java

Wed, 10 Oct 2012 16:48:21 -0700

author
jjg
date
Wed, 10 Oct 2012 16:48:21 -0700
changeset 1359
25e14ad23cef
parent 554
9d9f26857129
child 1362
c46e0c9940d6
permissions
-rw-r--r--

8000665: fix "internal API" comments on javadoc files
Reviewed-by: darcy

     1 /*
     2  * Copyright (c) 2003, 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;
    28 import com.sun.tools.doclets.internal.toolkit.taglets.*;
    30 /**
    31  * The output for HTML taglets.
    32  *
    33  *  <p><b>This is NOT part of any supported API.
    34  *  If you write code that depends on this, you do so at your own risk.
    35  *  This code and its internal interfaces are subject to change or
    36  *  deletion without notice.</b>
    37  *
    38  * @since 1.5
    39  * @author Jamie Ho
    40  */
    42 public class TagletOutputImpl implements TagletOutput {
    44     private StringBuffer output;
    46     public TagletOutputImpl(String o) {
    47         setOutput(o);
    48     }
    50     /**
    51      * {@inheritDoc}
    52      */
    53     public void setOutput (Object o) {
    54         output = new StringBuffer(o == null ? "" : (String) o);
    55     }
    57     /**
    58      * {@inheritDoc}
    59      */
    60     public void appendOutput(TagletOutput o) {
    61         output.append(o.toString());
    62     }
    64     /**
    65      * {@inheritDoc}
    66      */
    67     public boolean hasInheritDocTag() {
    68         return output.indexOf(InheritDocTaglet.INHERIT_DOC_INLINE_TAG) != -1;
    69     }
    71     public String toString() {
    72         return output.toString();
    73     }
    75     /**
    76      * Check whether the taglet output is empty.
    77      */
    78     public boolean isEmpty() {
    79         return (toString().trim().isEmpty());
    80     }
    81 }

mercurial