1   /*
2    * Copyright (c) 2004-2005 SLF4J.ORG
3    * Copyright (c) 2004-2005 QOS.ch
4    *
5    * All rights reserved.
6    *
7    * Permission is hereby granted, free of charge, to any person obtaining
8    * a copy of this software and associated documentation files (the
9    * "Software"), to  deal in  the Software without  restriction, including
10   * without limitation  the rights to  use, copy, modify,  merge, publish,
11   * distribute, and/or sell copies of  the Software, and to permit persons
12   * to whom  the Software is furnished  to do so, provided  that the above
13   * copyright notice(s) and this permission notice appear in all copies of
14   * the  Software and  that both  the above  copyright notice(s)  and this
15   * permission notice appear in supporting documentation.
16   *
17   * THE  SOFTWARE IS  PROVIDED  "AS  IS", WITHOUT  WARRANTY  OF ANY  KIND,
18   * EXPRESS OR  IMPLIED, INCLUDING  BUT NOT LIMITED  TO THE  WARRANTIES OF
19   * MERCHANTABILITY, FITNESS FOR  A PARTICULAR PURPOSE AND NONINFRINGEMENT
20   * OF  THIRD PARTY  RIGHTS. IN  NO EVENT  SHALL THE  COPYRIGHT  HOLDER OR
21   * HOLDERS  INCLUDED IN  THIS  NOTICE BE  LIABLE  FOR ANY  CLAIM, OR  ANY
22   * SPECIAL INDIRECT  OR CONSEQUENTIAL DAMAGES, OR  ANY DAMAGES WHATSOEVER
23   * RESULTING FROM LOSS  OF USE, DATA OR PROFITS, WHETHER  IN AN ACTION OF
24   * CONTRACT, NEGLIGENCE  OR OTHER TORTIOUS  ACTION, ARISING OUT OF  OR IN
25   * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
26   *
27   * Except as  contained in  this notice, the  name of a  copyright holder
28   * shall not be used in advertising or otherwise to promote the sale, use
29   * or other dealings in this Software without prior written authorization
30   * of the copyright holder.
31   *
32   */
33  
34  package org.slf4j.spi;
35  
36  import org.slf4j.ILoggerFactory;
37  
38  /**
39   * An internal interface which helps the static {@link org.slf4j.LoggerFactory} 
40   * class bind with the appropriate {@link ILoggerFactory} instance. 
41   * 
42   * @author Ceki Gülcü
43   */
44  public interface LoggerFactoryBinder {
45  
46    /**
47     * Return the instance of {@link ILoggerFactory} that 
48     * {@link org.slf4j.LoggerFactory} class should bind to.
49     * 
50     * @return the instance of {@link ILoggerFactory} that 
51     * {@link org.slf4j.LoggerFactory} class should bind to.
52     */
53    public ILoggerFactory getLoggerFactory();
54  
55    /**
56     * The String form of the {@link ILoggerFactory} object that this 
57     * <code>LoggerFactoryBinder</code> instance is <em>intended</em> to return. 
58     * 
59     * <p>This method allows the developer to intterogate this binder's intention 
60     * which may be different from the {@link ILoggerFactory} instance it is able to 
61     * yield in practice. The discrepency should only occur in case of errors.
62     * 
63     * @return the class name of the intended {@link ILoggerFactory} instance
64     */
65    public String getLoggerFactoryClassStr();
66  }