bpatel@766: /*
jjg@1985:  * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
bpatel@766:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
bpatel@766:  *
bpatel@766:  * This code is free software; you can redistribute it and/or modify it
bpatel@766:  * under the terms of the GNU General Public License version 2 only, as
bpatel@766:  * published by the Free Software Foundation.  Oracle designates this
bpatel@766:  * particular file as subject to the "Classpath" exception as provided
bpatel@766:  * by Oracle in the LICENSE file that accompanied this code.
bpatel@766:  *
bpatel@766:  * This code is distributed in the hope that it will be useful, but WITHOUT
bpatel@766:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
bpatel@766:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
bpatel@766:  * version 2 for more details (a copy is included in the LICENSE file that
bpatel@766:  * accompanied this code).
bpatel@766:  *
bpatel@766:  * You should have received a copy of the GNU General Public License version
bpatel@766:  * 2 along with this work; if not, write to the Free Software Foundation,
bpatel@766:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
bpatel@766:  *
bpatel@766:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
bpatel@766:  * or visit www.oracle.com if you need additional information or have any
bpatel@766:  * questions.
bpatel@766:  */
bpatel@766: 
bpatel@766: package com.sun.tools.doclets.formats.html.markup;
bpatel@766: 
jjg@1364: import java.io.IOException;
jjg@1364: import java.io.Writer;
jjg@1364: 
bpatel@766: import com.sun.tools.doclets.internal.toolkit.Content;
bpatel@766: import com.sun.tools.doclets.internal.toolkit.util.*;
bpatel@766: 
bpatel@766: /**
bpatel@766:  * Class for generating a comment for HTML pages of javadoc output.
bpatel@766:  *
jjg@1359:  *  <p><b>This is NOT part of any supported API.
jjg@1359:  *  If you write code that depends on this, you do so at your own risk.
jjg@1359:  *  This code and its internal interfaces are subject to change or
jjg@1359:  *  deletion without notice.</b>
jjg@1359:  *
bpatel@766:  * @author Bhavesh Patel
bpatel@766:  */
jjg@1364: public class Comment extends Content {
bpatel@766: 
bpatel@766:     private String commentText;
bpatel@766: 
bpatel@766:     /**
bpatel@766:      * Constructor to construct a Comment object.
bpatel@766:      *
bpatel@766:      * @param comment comment text for the comment
bpatel@766:      */
bpatel@766:     public Comment(String comment) {
bpatel@766:         commentText = nullCheck(comment);
bpatel@766:     }
bpatel@766: 
bpatel@766:     /**
bpatel@766:      * This method is not supported by the class.
bpatel@766:      *
bpatel@766:      * @param content content that needs to be added
bpatel@766:      * @throws DocletAbortException this method will always throw a
bpatel@766:      *                              DocletAbortException because it
bpatel@766:      *                              is not supported.
bpatel@766:      */
bpatel@766:     public void addContent(Content content) {
jjg@1985:         throw new DocletAbortException("not supported");
bpatel@766:     }
bpatel@766: 
bpatel@766:     /**
bpatel@766:      * This method is not supported by the class.
bpatel@766:      *
bpatel@766:      * @param stringContent string content that needs to be added
bpatel@766:      * @throws DocletAbortException this method will always throw a
bpatel@766:      *                              DocletAbortException because it
bpatel@766:      *                              is not supported.
bpatel@766:      */
bpatel@766:     public void addContent(String stringContent) {
jjg@1985:         throw new DocletAbortException("not supported");
bpatel@766:     }
bpatel@766: 
bpatel@766:     /**
bpatel@766:      * {@inheritDoc}
bpatel@766:      */
bpatel@766:     public boolean isEmpty() {
bpatel@766:         return commentText.isEmpty();
bpatel@766:     }
bpatel@766: 
bpatel@766:     /**
bpatel@766:      * {@inheritDoc}
bpatel@766:      */
jjg@1364:     @Override
jjg@1364:     public boolean write(Writer out, boolean atNewline) throws IOException {
jjg@1364:         if (!atNewline)
jjg@1364:             out.write(DocletConstants.NL);
jjg@1364:         out.write("<!-- ");
jjg@1364:         out.write(commentText);
jjg@1364:         out.write(" -->" + DocletConstants.NL);
jjg@1364:         return true;
bpatel@766:     }
bpatel@766: }