org.neo4j.logging.Log Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [http://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.logging;

import java.util.function.Consumer;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import org.neo4j.annotations.api.PublicApi;

/**
 * A log into which various levels of messages can be written
 */
@PublicApi
public interface Log
{
    /**
     * @return true if the current log level enables debug logging
     */
    boolean isDebugEnabled();

    /**
     * @return a {@link Logger} instance for writing debug messages
     * @deprecated Use {@link #debug(String)} directly.
     */
    @Nonnull
    @Deprecated( forRemoval = true, since = "4.2" )
    Logger debugLogger();

    /**
     * @param message The message to be written
     */
    void debug( @Nonnull String message );

    /**
     * @param message   The message to be written
     * @param throwable An exception that will also be written
     */
    void debug( @Nonnull String message, @Nonnull Throwable throwable );

    /**
     * @param format    A string format for writing a message
     * @param arguments Arguments to substitute into the message according to the format
     */
    void debug( @Nonnull String format, @Nullable Object... arguments );

    /**
     * @return a {@link Logger} instance for writing info messages
     * @deprecated Use {@link #info(String)}} directly.
     */
    @Nonnull
    @Deprecated( forRemoval = true, since = "4.2" )
    Logger infoLogger();

    /**
     * @param message The message to be written
     */
    void info( @Nonnull String message );

    /**
     * @param message   The message to be written
     * @param throwable An exception that will also be written
     */
    void info( @Nonnull String message, @Nonnull Throwable throwable );

    /**
     * @param format    A string format for writing a message
     * @param arguments Arguments to substitute into the message according to the format
     */
    void info( @Nonnull String format, @Nullable Object... arguments );

    /**
     * @return a {@link Logger} instance for writing warn messages
     * @deprecated Use {@link #warn(String)} directly.
     */
    @Nonnull
    @Deprecated( forRemoval = true, since = "4.2" )
    Logger warnLogger();

    /**
     * @param message The message to be written
     */
    void warn( @Nonnull String message );

    /**
     * @param message   The message to be written
     * @param throwable An exception that will also be written
     */
    void warn( @Nonnull String message, @Nonnull Throwable throwable );

    /**
     * @param format    A string format for writing a message
     * @param arguments Arguments to substitute into the message according to the format
     */
    void warn( @Nonnull String format, @Nullable Object... arguments );

    /**
     * @return a {@link Logger} instance for writing error messages
     * @deprecated Use {@link #error(String)} directly.
     */
    @Nonnull
    @Deprecated( forRemoval = true, since = "4.2" )
    Logger errorLogger();

    /**
     * @param message The message to be written
     */
    void error( @Nonnull String message );

    /**
     * @param message   The message to be written
     * @param throwable An exception that will also be written
     */
    void error( @Nonnull String message, @Nonnull Throwable throwable );

    /**
     * @param format    A string format for writing a message
     * @param arguments Arguments to substitute into the message according to the {@code format}
     */
    void error( @Nonnull String format, @Nullable Object... arguments );

    /**
     * Used to temporarily log several messages in bulk. The implementation may choose to
     * disable flushing, and may also block other operations until the bulk update is completed.
     *
     * @param consumer A consumer for the bulk {@link Log}
     */
    @Deprecated( forRemoval = true, since = "4.2" )
    void bulk( @Nonnull Consumer consumer );
}