com.kapil.framework.logger.ILogger Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of iframework Show documentation
This is a set of utilities and classes that I have found useful over the years. In my career spanning over a decade, I have time and again written the same code or some part of the code over and over again. I never found the time to collate the details in a reusable library. This project will be a collection of such files. The work that I have been doing is more than 5 years old, however the project has been conceived in 2011.
There is a newer version: 1.2.1
Show newest version
/*******************************************************************************
 * Copyright 2011 @ Kapil Viren Ahuja
 * 
 * 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.kapil.framework.logger;

/**
 * 
 * Interface for Logging messages using an existing logging framework. Exposes methods for the following basic
 * functionalities:
 * 
 * 

 * Logging {@link String} messages.
 * Logging messages and replacing the tokens provided as method parameters.
 * Logging {@link Object}.
 * 
 * 
 * 
 */
public interface ILogger
{ // NOPMD because a Logger class is designed to have these many methods.
    /**
     * Logs messages to level Trace.
     * 
     * @param message message of type {@link String} that needs to be logged.
     */
    void trace(String message);

    /**
     * Logs messages replacing all tokens ## with replacements to level Trace.
     * 
     * @param message message of type {@link String} that needs to be logged.
     * @param replacements an Array of {@link String} replacements that will replace the tokens ## in the
     *            message
     */
    void trace(String message, String[] replacements);

    /**
     * Logs messages replacing token ## with replacements to level Trace.
     * 
     * @param message message of type {@link String} that needs to be logged.
     * @param replacement a {@link String} that will replace the tokens ## in the message.
     */
    void trace(String message, String replacement);

    /**
     * Logs messages to level Trace. While providing implementations, developers can choose to log the
     * object as a object.toString() or converting them to XMLs.
     * 
     * @param object object that needs to be logged.
     */
    void trace(Object object);

    /**
     * Logs messages to level Debug.
     * 
     * @param message message of type {@link String} that needs to be logged.
     */
    void debug(String message);

    /**
     * Logs messages replacing all tokens ## with replacements to level Debug.
     * 
     * @param message message of type {@link String} that needs to be logged.
     * @param replacements an Array of {@link String} replacements that will replace the tokens ## in the
     *            message
     */
    void debug(String message, String[] replacements);

    /**
     * Logs messages replacing token ## with replacements to level Debug.
     * 
     * @param message message of type {@link String} that needs to be logged.
     * @param replacement a {@link String} that will replace the tokens ## in the message.
     */
    void debug(String message, String replacement);

    /**
     * Logs messages to level Debug. While providing implementations, developers can choose to log the
     * object as a object.toString() or converting them to XMLs.
     * 
     * @param object object that needs to be logged.
     */
    void debug(Object object);

    /**
     * Logs messages to level Info.
     * 
     * @param message message of type {@link String} that needs to be logged.
     */
    void info(String message);

    /**
     * Logs messages replacing all tokens ## with replacements to level Info.
     * 
     * @param message message of type {@link String} that needs to be logged.
     * @param replacements an Array of {@link String} replacements that will replace the tokens ## in the
     *            message
     */
    void info(String message, String[] replacements);

    /**
     * Logs messages replacing token ## with replacements to level Info.
     * 
     * @param message message of type {@link String} that needs to be logged.
     * @param replacement a {@link String} that will replace the tokens ## in the message.
     */
    void info(String message, String replacement);

    /**
     * Logs messages to level Info. While providing implementations, developers can choose to log the
     * object as a object.toString() or converting them to XMLs.
     * 
     * @param object object that needs to be logged.
     */
    void info(Object object);

    /**
     * Logs messages to level Warn.
     * 
     * @param message message of type {@link String} that needs to be logged.
     */
    void warn(String message);

    /**
     * Logs messages replacing all tokens ## with replacements to level Warn.
     * 
     * @param message message of type {@link String} that needs to be logged.
     * @param replacements an Array of {@link String} replacements that will replace the tokens ## in the
     *            message
     */
    void warn(String message, String[] replacements);

    /**
     * Logs messages replacing token ## with replacements to level Warn. 
     * 
     * @param message message of type {@link String} that needs to be logged.
     * @param replacement a {@link String} that will replace the tokens ## in the message.
     */
    void warn(String message, String replacement);

    

    /**
     * Logs messages to level Warn. While providing implementations, developers can choose to log the
     * object as a object.toString() or converting them to XMLs.
     * 
     * @param object object that needs to be logged.
     */
    void warn(Object object);

    /**
     * Logs messages to level Error.
     * 
     * @param message message of type {@link String} that needs to be logged.
     */
    void error(String message);

    /**
     * Logs messages replacing all tokens ## with replacements to level Error.
     * 
     * @param message message of type {@link String} that needs to be logged.
     * @param replacements an Array of {@link String} replacements that will replace the tokens ## in the
     *            message
     */
    void error(String message, String[] replacements);

    /**
     * Logs messages replacing token ## with replacements to level Error. 
     * 
     * @param message message of type {@link String} that needs to be logged.
     * @param replacement a {@link String} that will replace the tokens ## in the message.
     */
    void error(String message, String replacement);

    
    /**
     * Logs messages to level Error. While providing implementations, developers can choose to log the
     * object as a object.toString() or converting them to XMLs.
     * 
     * @param object object that needs to be logged.
     */
    void error(Object object);
}