org.opentripplanner.transit.raptor.api.debug.DebugLogger Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of otp Show documentation

The OpenTripPlanner multimodal journey planning system

There is a newer version: 2.5.0

package org.opentripplanner.transit.raptor.api.debug;


/**
 * The use of the API should provide a debug logger which map to what ever logging api
 * the caller use.
 */
@FunctionalInterface
public interface DebugLogger {
    /**
     * Check if debugging is enabled before doing heavy work like calculating statistics
     * before logging it.
     * 
     * PLEASE IMPLEMENT THIS AND RETURN TRUE TO ENABLE DEBUGGING.
     */
    default boolean isEnabled(DebugTopic topic) {
        return false;
    }


    /**
     * Prepare the debug logger for searching direction FORWARD or REVERSE. This method is optional
     * to implement, the default do nothing.
     * 
     * The method is called once before each search begin.
     */
    default void setSearchDirection(boolean forward) {
        // do nothing
    }

    /**
     * Implement this method to provide logging.
     */
    void debug(DebugTopic topic, String message);

    /**
     * Handy method which uses the Java String#format to format the message.
     */
    default void debug(DebugTopic topic, String format, Object... args) {
        if(isEnabled(topic)) {
            debug(topic, String.format(format, args));
        }
    }
}