Mercurial > jdk8-mips64-public > langtools / file comparison
comparison: src/share/classes/com/sun/tools/doclets/formats/html/markup/Comment.java
src/share/classes/com/sun/tools/doclets/formats/html/markup/Comment.java
- changeset 766
- 90af8d87741f
- child 793
- ffbf2b2a8611
equal
deleted
inserted
replaced
| 758:bcbc86cc5b31 | 766:90af8d87741f |
|---|---|
| 1 /* | |
| 2 * Copyright (c) 2010, 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 com.sun.tools.doclets.formats.html.markup; | |
| 27 | |
| 28 import com.sun.tools.doclets.internal.toolkit.Content; | |
| 29 import com.sun.tools.doclets.internal.toolkit.util.*; | |
| 30 | |
| 31 /** | |
| 32 * Class for generating a comment for HTML pages of javadoc output. | |
| 33 * | |
| 34 * @author Bhavesh Patel | |
| 35 */ | |
| 36 public class Comment extends Content{ | |
| 37 | |
| 38 private String commentText; | |
| 39 | |
| 40 /** | |
| 41 * Constructor to construct a Comment object. | |
| 42 * | |
| 43 * @param comment comment text for the comment | |
| 44 */ | |
| 45 public Comment(String comment) { | |
| 46 commentText = nullCheck(comment); | |
| 47 } | |
| 48 | |
| 49 /** | |
| 50 * This method is not supported by the class. | |
| 51 * | |
| 52 * @param content content that needs to be added | |
| 53 * @throws DocletAbortException this method will always throw a | |
| 54 * DocletAbortException because it | |
| 55 * is not supported. | |
| 56 */ | |
| 57 public void addContent(Content content) { | |
| 58 throw new DocletAbortException(); | |
| 59 } | |
| 60 | |
| 61 /** | |
| 62 * This method is not supported by the class. | |
| 63 * | |
| 64 * @param stringContent string content that needs to be added | |
| 65 * @throws DocletAbortException this method will always throw a | |
| 66 * DocletAbortException because it | |
| 67 * is not supported. | |
| 68 */ | |
| 69 public void addContent(String stringContent) { | |
| 70 throw new DocletAbortException(); | |
| 71 } | |
| 72 | |
| 73 /** | |
| 74 * {@inheritDoc} | |
| 75 */ | |
| 76 public boolean isEmpty() { | |
| 77 return commentText.isEmpty(); | |
| 78 } | |
| 79 | |
| 80 /** | |
| 81 * {@inheritDoc} | |
| 82 */ | |
| 83 public void write(StringBuilder contentBuilder) { | |
| 84 if (!endsWithNewLine(contentBuilder)) | |
| 85 contentBuilder.append("\n"); | |
| 86 contentBuilder.append("<!-- "); | |
| 87 contentBuilder.append(commentText); | |
| 88 contentBuilder.append(" -->\n"); | |
| 89 } | |
| 90 } |
