com.hhandoko.cassandra.migration.internal.util.logging.Log.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cassandra-migration Show documentation

Database migration tool for Cassandra

The newest version!

/**
 * File     : Log.kt
 * License  :
 *   Original   - Copyright (c) 2010 - 2016 Boxfuse GmbH
 *   Derivative - Copyright (c) 2016 - 2018 cassandra-migration Contributors
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *           http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 */
package com.hhandoko.cassandra.migration.internal.util.logging

/**
 * A logger.
 */
interface Log {

    /**
     * Logs a debug message.
     *
     * @param message The message to log.
     */
    fun debug(message: String)

    /**
     * Logs an info message.
     *
     * @param message The message to log.
     */
    fun info(message: String)

    /**
     * Logs a warning message.
     *
     * @param message The message to log.
     */
    fun warn(message: String)

    /**
     * Logs an error message.
     *
     * @param message The message to log.
     */
    fun error(message: String)

    /**
     * Logs an error message and the exception that caused it.
     *
     * @param message The message to log.
     * @param e The exception that caused the error.
     */
    fun error(message: String, e: Exception)

}