001/*
002 * Copyright (c) 2010, 2022, Oracle and/or its affiliates. All rights reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation.  Oracle designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Oracle in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
022 * or visit www.oracle.com if you need additional information or have any
023 * questions.
024 */
025
026package org.jdrupes.mdoclet.internal.doclets.formats.html.markup;
027
028import java.io.IOException;
029import java.io.Writer;
030import java.util.Objects;
031
032import org.jdrupes.mdoclet.internal.doclets.toolkit.Content;
033
034/**
035 * Class for generating a comment for HTML pages of javadoc output.
036 */
037public class Comment extends Content {
038
039    private final String commentText;
040
041    /**
042     * Constructor to construct a Comment object.
043     *
044     * @param comment comment text for the comment
045     */
046    public Comment(String comment) {
047        commentText = Objects.requireNonNull(comment);
048    }
049
050    @Override
051    public boolean isEmpty() {
052        return commentText.isEmpty();
053    }
054
055    @Override
056    public boolean write(Writer out, String newline, boolean atNewline) throws IOException {
057        if (!atNewline) {
058            out.write(newline);
059        }
060        out.write("<!-- ");
061        out.write(commentText.replace("\n", newline));
062        out.write(" -->");
063        out.write(newline);
064        return true;
065    }
066}