/*

 * Copyright (c) 2010, 2016, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package jdk.javadoc.internal.doclets.formats.html.markup;

import java.io.IOException;

import java.io.Writer;

import jdk.javadoc.internal.doclets.toolkit.Content;

import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException;

import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants;

/**

 * Class for generating a comment for HTML pages of javadoc output.

 *

 *  <p><b>This is NOT part of any supported API.

 *  If you write code that depends on this, you do so at your own risk.

 *  This code and its internal interfaces are subject to change or

 *  deletion without notice.</b>

 *

 * @author Bhavesh Patel

 */

public class Comment extends Content {

    private String commentText;

    /**

     * Constructor to construct a Comment object.

     *

     * @param comment comment text for the comment

     */

    public Comment(String comment) {

        commentText = nullCheck(comment);

    }

    /**

     * This method is not supported by the class.

     *

     * @param content content that needs to be added

     * @throws DocletAbortException this method will always throw a

     *                              DocletAbortException because it

     *                              is not supported.

     */

    public void addContent(Content content) {

        throw new DocletAbortException("not supported");

    }

    /**

     * This method is not supported by the class.

     *

     * @param stringContent string content that needs to be added

     * @throws DocletAbortException this method will always throw a

     *                              DocletAbortException because it

     *                              is not supported.

     */

    @Override

    public void addContent(CharSequence stringContent) {

        throw new DocletAbortException("not supported");

    }

    /**

     * {@inheritDoc}

     */

    public boolean isEmpty() {

        return commentText.isEmpty();

    }

    /**

     * {@inheritDoc}

     */

    @Override

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

        if (!atNewline)

            out.write(DocletConstants.NL);

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

        out.write(commentText);

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

        return true;

    }

}