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.IMarkerFactory;
37
38
39 /**
40 * An internal interface which helps the static {@link org.slf4j.MarkerFactory}
41 * class bind with the appropriate {@link IMarkerFactory} instance.
42 *
43 * @author Ceki Gülcü
44 */
45 public interface MarkerFactoryBinder {
46
47 /**
48 * Return the instance of {@link IMarkerFactory} that
49 * {@link org.slf4j.MarkerFactory} class should bind to.
50 *
51 * @return the instance of {@link IMarkerFactory} that
52 * {@link org.slf4j.MarkerFactory} class should bind to.
53 */
54 public IMarkerFactory getMarkerFactory();
55
56 /**
57 * The String form of the {@link IMarkerFactory} object that this
58 * <code>MarkerFactoryBinder</code> instance is <em>intended</em> to return.
59 *
60 * <p>This method allows the developer to intterogate this binder's intention
61 * which may be different from the {@link IMarkerFactory} instance it is able to
62 * return. Such a discrepency should only occur in case of errors.
63 *
64 * @return the class name of the intended {@link IMarkerFactory} instance
65 */
66 public String getMarkerFactoryClassStr();
67 }