org.neo4j.shell.printer.Printer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cypher-shell Show documentation

Cypher Shell

There is a newer version: 2025.02.0

/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [https://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.neo4j.shell.printer;

import org.neo4j.shell.cli.Format;
import org.neo4j.shell.prettyprint.LinePrinter;

public interface Printer extends LinePrinter {
    /**
     * Print a sanitized cause of the specified error. If debug mode is enabled, a full stacktrace should be printed as well.
     *
     * @param throwable to print to the error stream
     */
    void printError(Throwable throwable);

    /**
     * Print the designated text to configured error stream.
     *
     * @param text to print to the error stream
     */
    void printError(String text);

    /**
     * @return the current format of the printer
     */
    Format getFormat();

    /**
     * Set the output format on the printer
     *
     * @param format to set
     */
    void setFormat(Format format);

    /**
     * Convenience method which only prints the given text to the output stream if the format set is {@link Format#VERBOSE}.
     *
     * @param text to print to the output stream
     */
    default void printIfVerbose(String text) {
        if (Format.VERBOSE.equals(getFormat())) {
            printOut(text);
        }
    }

    /**
     * Convenience method which only prints the given text to the output stream if the format set is {@link Format#PLAIN}.
     *
     * @param text to print to the output stream
     */
    default void printIfPlain(String text) {
        if (Format.PLAIN.equals(getFormat())) {
            printOut(text);
        }
    }
}