NamedLoggerBase xref

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.helpers;
    26
    27  import java.io.ObjectStreamException;
    28  import java.io.Serializable;
    29
    30  import org.slf4j.Logger;
    31  import org.slf4j.LoggerFactory;
    32
    33  /**
    34   * Serves as base class for named logger implementation. More significantly, this
    35   * class establishes deserialization behavior.
    36   *
    37   * @author Ceki Gulcu
    38   * @see #readResolve
    39   * @since 1.5.3
    40   */
    41  abstract class NamedLoggerBase implements Logger, Serializable {
    42
    43      private static final long serialVersionUID = 7535258609338176893L;
    44
    45      protected String name;
    46
    47      public String getName() {
    48          return name;
    49      }
    50
    51      /**
    52       * Replace this instance with a homonymous (same name) logger returned
    53       * by LoggerFactory. Note that this method is only called during
    54       * deserialization.
    55       *
    56       * <p>
    57       * This approach will work well if the desired ILoggerFactory is the one
    58       * references by LoggerFactory. However, if the user manages its logger hierarchy
    59       * through a different (non-static) mechanism, e.g. dependency injection, then
    60       * this approach would be mostly counterproductive.
    61       *
    62       * @return logger with same name as returned by LoggerFactory
    63       * @throws ObjectStreamException
    64       */
    65      protected Object readResolve() throws ObjectStreamException {
    66          // using getName() instead of this.name works even for
    67          // NOPLogger
    68          return LoggerFactory.getLogger(getName());
    69      }
    70
    71  }