jdk8-mips64-public/langtools: src/share/classes/com/sun/tools/doclets/formats/html/markup/Comment.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 a comment for HTML pages 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 Comment extends Content {

    46     private String commentText;

    48     /**

    49      * Constructor to construct a Comment object.

    50      *

    51      * @param comment comment text for the comment

    52      */

    53     public Comment(String comment) {

    54         commentText = nullCheck(comment);

    55     }

    57     /**

    58      * This method is not supported by the class.

    59      *

    60      * @param content content that needs to be added

    61      * @throws DocletAbortException this method will always throw a

    62      *                              DocletAbortException because it

    63      *                              is not supported.

    64      */

    65     public void addContent(Content content) {

    66         throw new DocletAbortException();

    67     }

    69     /**

    70      * This method is not supported by the class.

    71      *

    72      * @param stringContent string content that needs to be added

    73      * @throws DocletAbortException this method will always throw a

    74      *                              DocletAbortException because it

    75      *                              is not supported.

    76      */

    77     public void addContent(String stringContent) {

    78         throw new DocletAbortException();

    79     }

    81     /**

    82      * {@inheritDoc}

    83      */

    84     public boolean isEmpty() {

    85         return commentText.isEmpty();

    86     }

    88     /**

    89      * {@inheritDoc}

    90      */

    91     @Override

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

    93         if (!atNewline)

    94             out.write(DocletConstants.NL);

    95         out.write("<!-- ");

    96         out.write(commentText);

    97         out.write(" -->" + DocletConstants.NL);

    98         return true;

    99     }

   100 }

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