/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2020 Vimeo
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package com.vimeo.networking2.logging

/**
 * A logger interface for the networking library.
 */
@Suppress("FunctionMinLength")
interface LogDelegate {
    /**
     * Log an error.
     *
     * @param error A description of the error that occurred.
     */
    fun e(error: String)

    /**
     * Log an error.
     *
     * @param error A description of the error that occurred.
     * @param exception The exception that caused the error.
     */
    fun e(error: String, exception: Exception)

    /**
     * Log a debug level message.
     *
     * @param message The message to be logged.
     */
    fun d(message: String)

    /**
     * Log a verbose level message.
     *
     * @param message The message to be logged.
     */
    fun v(message: String)

    /**
     * The level of logging to be performed.
     *
     * @param level The log level represented as an integer.
     */
    @Suppress("MagicNumber")
    enum class Level(val level: Int) {
        VERBOSE(0),
        DEBUG(1),
        ERROR(2),
        NONE(3)
    }
}
