1 /* 2 * Copyright (c) 2010, 2015, 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 */ 25 26 package jdk.javadoc.internal.doclets.formats.html.markup; 27 28 import java.io.IOException; 29 import java.io.Writer; 30 31 import jdk.javadoc.internal.doclets.toolkit.Content; 32 import jdk.javadoc.internal.doclets.toolkit.util.DocletAbortException; 33 import jdk.javadoc.internal.doclets.toolkit.util.DocletConstants; 34 35 /** 36 * Class for generating a comment for HTML pages of javadoc output. 37 * 38 * <p><b>This is NOT part of any supported API. 39 * If you write code that depends on this, you do so at your own risk. 40 * This code and its internal interfaces are subject to change or 41 * deletion without notice.</b> 42 * 43 * @author Bhavesh Patel 44 */ 45 public class Comment extends Content { 46 47 private String commentText; 48 49 /** 50 * Constructor to construct a Comment object. 51 * 52 * @param comment comment text for the comment 53 */ 54 public Comment(String comment) { 55 commentText = nullCheck(comment); 56 } 57 58 /** 59 * This method is not supported by the class. 60 * 61 * @param content content that needs to be added 62 * @throws DocletAbortException this method will always throw a 63 * DocletAbortException because it 64 * is not supported. 65 */ 66 public void addContent(Content content) { 67 throw new DocletAbortException("not supported"); 68 } 69 70 /** 71 * This method is not supported by the class. 72 * 73 * @param stringContent string content that needs to be added 74 * @throws DocletAbortException this method will always throw a 75 * DocletAbortException because it 76 * is not supported. 77 */ 78 public void addContent(String stringContent) { 79 throw new DocletAbortException("not supported"); 80 } 81 82 /** 83 * {@inheritDoc} 84 */ 85 public boolean isEmpty() { 86 return commentText.isEmpty(); 87 } 88 89 /** 90 * {@inheritDoc} 91 */ 92 @Override 93 public boolean write(Writer out, boolean atNewline) throws IOException { 94 if (!atNewline) 95 out.write(DocletConstants.NL); 96 out.write("<!-- "); 97 out.write(commentText); 98 out.write(" -->" + DocletConstants.NL); 99 return true; 100 } 101 }