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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of logging Show documentation
Neo4j Graph Data Science :: Logging
There is a newer version: 2.13.2
/*
 * 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.gds.logging;

/**
 * We have our own log interface. This enables us to evolve the interface, to run without Neo4j,
 * to not have dependencies on Neo4j everywhere.
 * 
 * As a start we mimic the name and methods from Neo4j in order to make migration easy;
 * you could imagine a big search+replace of the import statement, for example.
 * Later it might make sense to rename to GDSLog to make the conceptual split more obvious.
 */
public interface Log {
    void info(String message);

    void info(String format, Object... arguments);

    void warn(String message, Exception e);

    void warn(String format, Object... arguments);

    boolean isDebugEnabled();

    void debug(String format, Object... arguments);

    /**
     * This is terrible, but necessary in the short term.
     * We want to eventually only have our own GDS log everywhere.
     * When working as a Neo4j plugin, we then want to wrap the Neo4j log using an adapter.
     * Until we have migrated all our internal usages of Neo4j's log, this is a handy little workaround.
     * Do not use this back door except at boundaries of non-ported code please.
     *
     * @return Object type that you can cast, to avoid silly versioning problems
     *
     * @deprecated We promise to rid of this very soon!
     */
    @Deprecated
    Object getNeo4jLog();

    /**
     * Here is some convenience for daily engineering toil, do not use for realz.
     */
    static Log noOpLog() {
        return new Log() {
            @Override
            public void info(String message) {

            }

            @Override
            public void info(String format, Object... arguments) {

            }

            @Override
            public void warn(String message, Exception e) {

            }

            @Override
            public void warn(String format, Object... arguments) {

            }

            @Override
            public boolean isDebugEnabled() {
                return false;
            }

            @Override
            public void debug(String format, Object... arguments) {

            }

            @Override
            public Object getNeo4jLog() {
                throw new UnsupportedOperationException("Not supported for this shunt.");
            }
        };
    }
}