001/**
002 * Copyright (c) 2004-2011 QOS.ch
003 * All rights reserved.
004 *
005 * Permission is hereby granted, free  of charge, to any person obtaining
006 * a  copy  of this  software  and  associated  documentation files  (the
007 * "Software"), to  deal in  the Software without  restriction, including
008 * without limitation  the rights to  use, copy, modify,  merge, publish,
009 * distribute,  sublicense, and/or sell  copies of  the Software,  and to
010 * permit persons to whom the Software  is furnished to do so, subject to
011 * the following conditions:
012 *
013 * The  above  copyright  notice  and  this permission  notice  shall  be
014 * included in all copies or substantial portions of the Software.
015 *
016 * THE  SOFTWARE IS  PROVIDED  "AS  IS", WITHOUT  WARRANTY  OF ANY  KIND,
017 * EXPRESS OR  IMPLIED, INCLUDING  BUT NOT LIMITED  TO THE  WARRANTIES OF
018 * MERCHANTABILITY,    FITNESS    FOR    A   PARTICULAR    PURPOSE    AND
019 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
020 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
021 * OF CONTRACT, TORT OR OTHERWISE,  ARISING FROM, OUT OF OR IN CONNECTION
022 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
023 *
024 */
025package org.slf4j.spi;
026
027import org.slf4j.ILoggerFactory;
028
029/**
030 * An internal interface which helps the static {@link org.slf4j.LoggerFactory} 
031 * class bind with the appropriate {@link ILoggerFactory} instance. 
032 * 
033 * @author Ceki Gülcü
034 */
035public interface LoggerFactoryBinder {
036
037    /**
038     * Return the instance of {@link ILoggerFactory} that 
039     * {@link org.slf4j.LoggerFactory} class should bind to.
040     * 
041     * @return the instance of {@link ILoggerFactory} that 
042     * {@link org.slf4j.LoggerFactory} class should bind to.
043     */
044    public ILoggerFactory getLoggerFactory();
045
046    /**
047     * The String form of the {@link ILoggerFactory} object that this 
048     * <code>LoggerFactoryBinder</code> instance is <em>intended</em> to return. 
049     * 
050     * <p>This method allows the developer to interrogate this binder's intention
051     * which may be different from the {@link ILoggerFactory} instance it is able to 
052     * yield in practice. The discrepancy should only occur in case of errors.
053     * 
054     * @return the class name of the intended {@link ILoggerFactory} instance
055     */
056    public String getLoggerFactoryClassStr();
057}