View Javadoc

    1   /**
    2    * Copyright (c) 2004-2011 QOS.ch
    3    * All rights reserved.
    4    *
    5    * Permission is hereby granted, free  of charge, to any person obtaining
    6    * a  copy  of this  software  and  associated  documentation files  (the
    7    * "Software"), to  deal in  the Software without  restriction, including
    8    * without limitation  the rights to  use, copy, modify,  merge, publish,
    9    * distribute,  sublicense, and/or sell  copies of  the Software,  and to
    10   * permit persons to whom the Software  is furnished to do so, subject to
    11   * the following conditions:
    12   *
    13   * The  above  copyright  notice  and  this permission  notice  shall  be
    14   * included in all copies or substantial portions of the Software.
    15   *
    16   * THE  SOFTWARE IS  PROVIDED  "AS  IS", WITHOUT  WARRANTY  OF ANY  KIND,
    17   * EXPRESS OR  IMPLIED, INCLUDING  BUT NOT LIMITED  TO THE  WARRANTIES OF
    18   * MERCHANTABILITY,    FITNESS    FOR    A   PARTICULAR    PURPOSE    AND
    19   * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
    20   * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
    21   * OF CONTRACT, TORT OR OTHERWISE,  ARISING FROM, OUT OF OR IN CONNECTION
    22   * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
    23   *
    24   */
    25  package org.slf4j.spi;
    26
    27  import org.slf4j.Logger;
    28  import org.slf4j.Marker;
    29
    30  /**
    31   * An <b>optional</b> interface helping integration with logging systems capable of
    32   * extracting location information. This interface is mainly used by SLF4J bridges
    33   * such as jcl-over-slf4j, jul-to-slf4j and log4j-over-slf4j or {@link Logger} wrappers
    34   * which need to provide hints so that the underlying logging system can extract
    35   * the correct location information (method name, line number).
    36   *
    37   * @author Ceki Gulcu
    38   * @since 1.3
    39   */
    40  public interface LocationAwareLogger extends Logger {
    41
    42      // these constants should be in EventContants. However, in order to preserve binary backward compatibility
    43      // we keep these constants here
    44      final public int TRACE_INT = 00;
    45      final public int DEBUG_INT = 10;
    46      final public int INFO_INT = 20;
    47      final public int WARN_INT = 30;
    48      final public int ERROR_INT = 40;
    49
    50      /**
    51       * Printing method with support for location information.
    52       *
    53       * @param marker The marker to be used for this event, may be null.
    54       * @param fqcn The fully qualified class name of the <b>logger instance</b>,
    55       * typically the logger class, logger bridge or a logger wrapper.
    56       * @param level One of the level integers defined in this interface
    57       * @param message The message for the log event
    58       * @param t Throwable associated with the log event, may be null.
    59       */
    60      public void log(Marker marker, String fqcn, int level, String message, Object[] argArray, Throwable t);
    61
    62  }