org.neo4j.kernel.logging.ConsoleLogger Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of neo4j-kernel Show documentation
Neo4j kernel is a lightweight, embedded Java database designed to store data structured as graphs rather than tables. For more information, see http://neo4j.org.
There is a newer version: 5.26.0
Show newest version
/*
 * Copyright (c) 2002-2015 "Neo Technology,"
 * Network Engine for Objects in Lund AB [http://neotechnology.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.kernel.logging;

import org.neo4j.kernel.impl.util.StringLogger;

import static org.neo4j.kernel.logging.LogMarker.CONSOLE_MARK;

/**
 * Logger that will log to a console in addition to a normal {@link StringLogger}.
 * Messages logged in here are user facing so extra consideration should be made about its contents.
 */
public class ConsoleLogger
{
    private final StringLogger realLogger;

    public ConsoleLogger( StringLogger realLogger )
    {
        this.realLogger = realLogger;
    }

    /**
     * Logs a message to the user.
     * @param message the message to log.
     */
    public void log( String message )
    {
        realLogger.info( message, null, false, CONSOLE_MARK );
    }

    /**
     * Logs a message to the user.
     * @param format the format in {@link String#format(String, Object...)}.
     * @param parameters the parameters that go into the format.
     */
    public void log( String format, Object... parameters )
    {
        log( String.format( format, parameters ) );
    }

    /**
     * Logs a warning to the user.
     * @param message warning message
     */
    public void warn( String message )
    {
        realLogger.warn( message, null, false, CONSOLE_MARK );
    }

    /**
     * Logs a warning to the user.
     * @param format the format in {@link String#format(String, Object...)}.
     * @param parameters the parameters that go into the format.
     */
    public void warn( String format, Object... parameters )
    {
        warn( String.format( format, parameters ) );
    }

    /**
     * Logs a warning, including a cause to the user.
     * @param message the warning message.
     * @param warning the cause of the warning
     * @deprecated since users shouldn't have to see stack traces. Stack traces are for
     * developers, not for users. This method exists due to removing any of other logging frameworks
     * that would log to the console.
     */
    @Deprecated
    public void warn( String message, Throwable warning )
    {
        realLogger.warn( message, warning, false, CONSOLE_MARK );
    }

    /**
     * Logs an error to the user.
     * @param message error message
     */
    public void error( String message )
    {
        realLogger.error( message );
    }

    /**
     * Logs an error to the user.
     * @param format the format in {@link String#format(String, Object...)}.
     * @param parameters the parameters that go into the format.
     */
    public void error( String format, Object... parameters )
    {
        error( String.format(  format, parameters ) );
    }

    /**
     * Logs an error, including a cause to the user.
     * @param message the warning message.
     * @param error the cause of the error
     * @deprecated since users shouldn't have to see stack traces. Stack traces are for
     * developers, not for users. This method exists due to removing any of other logging frameworks
     * that would log to the console.
     */
    @Deprecated
    public void error( String message, Throwable error )
    {
        realLogger.error( message, error, true, CONSOLE_MARK );
    }

    public static final ConsoleLogger DEV_NULL = new ConsoleLogger( StringLogger.DEV_NULL );
}