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

     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/src/share/classes/com/sun/tools/doclets/formats/html/markup/Comment.java	Wed Dec 01 11:02:38 2010 -0800
     1.3 @@ -0,0 +1,90 @@
     1.4 +/*
     1.5 + * Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
     1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     1.7 + *
     1.8 + * This code is free software; you can redistribute it and/or modify it
     1.9 + * under the terms of the GNU General Public License version 2 only, as
    1.10 + * published by the Free Software Foundation.  Oracle designates this
    1.11 + * particular file as subject to the "Classpath" exception as provided
    1.12 + * by Oracle in the LICENSE file that accompanied this code.
    1.13 + *
    1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
    1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    1.16 + * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    1.17 + * version 2 for more details (a copy is included in the LICENSE file that
    1.18 + * accompanied this code).
    1.19 + *
    1.20 + * You should have received a copy of the GNU General Public License version
    1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
    1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    1.23 + *
    1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    1.25 + * or visit www.oracle.com if you need additional information or have any
    1.26 + * questions.
    1.27 + */
    1.28 +
    1.29 +package com.sun.tools.doclets.formats.html.markup;
    1.30 +
    1.31 +import com.sun.tools.doclets.internal.toolkit.Content;
    1.32 +import com.sun.tools.doclets.internal.toolkit.util.*;
    1.33 +
    1.34 +/**
    1.35 + * Class for generating a comment for HTML pages of javadoc output.
    1.36 + *
    1.37 + * @author Bhavesh Patel
    1.38 + */
    1.39 +public class Comment extends Content{
    1.40 +
    1.41 +    private String commentText;
    1.42 +
    1.43 +    /**
    1.44 +     * Constructor to construct a Comment object.
    1.45 +     *
    1.46 +     * @param comment comment text for the comment
    1.47 +     */
    1.48 +    public Comment(String comment) {
    1.49 +        commentText = nullCheck(comment);
    1.50 +    }
    1.51 +
    1.52 +    /**
    1.53 +     * This method is not supported by the class.
    1.54 +     *
    1.55 +     * @param content content that needs to be added
    1.56 +     * @throws DocletAbortException this method will always throw a
    1.57 +     *                              DocletAbortException because it
    1.58 +     *                              is not supported.
    1.59 +     */
    1.60 +    public void addContent(Content content) {
    1.61 +        throw new DocletAbortException();
    1.62 +    }
    1.63 +
    1.64 +    /**
    1.65 +     * This method is not supported by the class.
    1.66 +     *
    1.67 +     * @param stringContent string content that needs to be added
    1.68 +     * @throws DocletAbortException this method will always throw a
    1.69 +     *                              DocletAbortException because it
    1.70 +     *                              is not supported.
    1.71 +     */
    1.72 +    public void addContent(String stringContent) {
    1.73 +        throw new DocletAbortException();
    1.74 +    }
    1.75 +
    1.76 +    /**
    1.77 +     * {@inheritDoc}
    1.78 +     */
    1.79 +    public boolean isEmpty() {
    1.80 +        return commentText.isEmpty();
    1.81 +    }
    1.82 +
    1.83 +    /**
    1.84 +     * {@inheritDoc}
    1.85 +     */
    1.86 +    public void write(StringBuilder contentBuilder) {
    1.87 +        if (!endsWithNewLine(contentBuilder))
    1.88 +            contentBuilder.append("\n");
    1.89 +        contentBuilder.append("<!-- ");
    1.90 +        contentBuilder.append(commentText);
    1.91 +        contentBuilder.append(" -->\n");
    1.92 +    }
    1.93 +}