Reporter.java

/*
 * Copyright (c) 1998, 2021, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package jdk.javadoc.doclet;

import java.io.PrintWriter;
import java.util.Locale;
import javax.lang.model.element.Element;
import javax.tools.Diagnostic;
import javax.tools.FileObject;

import com.sun.source.util.DocTreePath;

/**
 * Interface for reporting diagnostics and other messages.
 *
 * <p>Diagnostics consist of a {@link Diagnostic.Kind diagnostic kind} and a message,
 * and may additionally be associated with an {@link Element element},
 * a {@link DocTreePath tree node} in a documentation comment,
 * or an arbitrary position in a given {@link FileObject file}.
 * Other messages may be written directly to one of two streams that are informally
 * for use by "standard output" and "diagnostic output", where "standard output"
 * means the output that is the expected result of executing some operation,
 * such as the command-line help that is generated when using a {@code --help} option,
 * and "diagnostic output" refers to any errors, warnings and other output that is
 * a side-effect of executing the operation.
 *
 * <p>The exact manner in which diagnostics are output is unspecified and depends
 * on the enclosing context. For example:
 * <ul>
 * <li>The {@link javax.tools.DocumentationTool} API allows a client to specify a
 * {@link javax.tools.DiagnosticListener} to which diagnostics will be
 * {@link javax.tools.DiagnosticListener#report reported}. If no listener is specified,
 * diagnostics will be written to a given stream, or to {@code System.err} if no such
 * stream is provided.
 * <li>The {@link java.util.spi.ToolProvider} API allows a client to specify
 * the streams to be used for reporting standard and diagnostic output.
 * </ul>
 *
 * @since 9
 */
public interface Reporter {

    /**
     * Prints a diagnostic message.
     *
     * @param kind    the kind of diagnostic
     * @param message the message to be printed
     */
    void print(Diagnostic.Kind kind, String message);

    /**
     * Prints a diagnostic message related to a tree node in a documentation comment.
     *
     * @param kind    the kind of diagnostic
     * @param path    the path for the tree node
     * @param message the message to be printed
     */
    void print(Diagnostic.Kind kind, DocTreePath path, String message);

    /**
     * Prints a diagnostic message related to an element.
     *
     * @param kind    the kind of diagnostic
     * @param element the element
     * @param message the message to be printed
     */
    void print(Diagnostic.Kind kind, Element element, String message);

    /**
     * Prints a diagnostic message related to a position within a range of characters in a file.
     * The positions are all 0-based character offsets from the beginning of content of the file.
     * The positions should satisfy the relation {@code start <= pos <= end}.
     *
     * @param kind    the kind of diagnostic
     * @param file    the file
     * @param start   the beginning of the enclosing range
     * @param pos     the position
     * @param end     the end of the enclosing range
     * @param message the message to be printed
     *
     * @since 17
     */
    void print(Diagnostic.Kind kind, FileObject file, int start, int pos, int end, String message);

    /**
     * Returns a writer that can be used to write non-diagnostic output,
     * or {@code null} if no such writer is available.
     *
     * @apiNote
     * The value may or may not be the same as that returned by {@link #getDiagnosticWriter()}.
     *
     * @implSpec
     * This implementation returns {@code null}.
     * The implementation provided by the {@code javadoc} tool to
     * {@link Doclet#init(Locale, Reporter) initialize} a doclet
     * always returns a non-{@code null} value.
     *
     * @return the writer
     * @since 17
     */
    default PrintWriter getStandardWriter() {
        return null;
    }

    /**
     * Returns a writer that can be used to write diagnostic output,
     * or {@code null} if no such writer is available.
     *
     * @apiNote
     * The value may or may not be the same as that returned by {@link #getStandardWriter()}.
     *
     * @implSpec
     * This implementation returns {@code null}.
     * The implementation provided by the {@code javadoc} tool to
     * {@link Doclet#init(Locale, Reporter) initialize} a doclet
     * always returns a non-{@code null} value.
     *
     * @return the writer
     * @since 17
     */
    default PrintWriter getDiagnosticWriter() {
        return null;
    }

}