Home | History | Annotate | Download | only in spi
      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.ILoggerFactory;
     28 
     29 /**
     30  * An internal interface which helps the static {@link org.slf4j.LoggerFactory}
     31  * class bind with the appropriate {@link ILoggerFactory} instance.
     32  *
     33  * @author Ceki Gülcü
     34  */
     35 public interface LoggerFactoryBinder {
     36 
     37     /**
     38      * Return the instance of {@link ILoggerFactory} that
     39      * {@link org.slf4j.LoggerFactory} class should bind to.
     40      *
     41      * @return the instance of {@link ILoggerFactory} that
     42      * {@link org.slf4j.LoggerFactory} class should bind to.
     43      */
     44     public ILoggerFactory getLoggerFactory();
     45 
     46     /**
     47      * The String form of the {@link ILoggerFactory} object that this
     48      * <code>LoggerFactoryBinder</code> instance is <em>intended</em> to return.
     49      *
     50      * <p>This method allows the developer to intterogate this binder's intention
     51      * which may be different from the {@link ILoggerFactory} instance it is able to
     52      * yield in practice. The discrepency should only occur in case of errors.
     53      *
     54      * @return the class name of the intended {@link ILoggerFactory} instance
     55      */
     56     public String getLoggerFactoryClassStr();
     57 }
     58