SLF4J API Module 2.0.17 · org.slf4j.LoggerFactory · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
private static final String[]	API_COMPATIBILITY_LIST It is LoggerFactory's responsibility to track version changes and manage the compatibility list.
pack-priv static final String	CODES_PREFIX
pack-priv static final String	CONNECTED_WITH_MSG
pack-priv static boolean	DETECT_LOGGER_NAME_MISMATCH
pack-priv static final String	DETECT_LOGGER_NAME_MISMATCH_PROPERTY
pack-priv static final int	FAILED_INITIALIZATION
pack-priv static final String	IGNORED_BINDINGS_URL
pack-priv static volatile int	INITIALIZATION_STATE
pack-priv static final String	JAVA_VENDOR_PROPERTY
pack-priv static final String	LOGGER_NAME_MISMATCH_URL
pack-priv static final String	MULTIPLE_BINDINGS_URL
pack-priv static final String	NO_PROVIDERS_URL
pack-priv static final int	NOP_FALLBACK_INITIALIZATION
pack-priv static final NOP_FallbackServiceProvider	NOP_FALLBACK_SERVICE_PROVIDER
pack-priv static final int	ONGOING_INITIALIZATION
pack-priv static volatile SLF4JServiceProvider	PROVIDER
public static final String	PROVIDER_PROPERTY_KEY System property for explicitly setting the provider class.
pack-priv static final String	REPLAY_URL
private static final String	STATIC_LOGGER_BINDER_PATH
pack-priv static final SubstituteServiceProvider	SUBST_PROVIDER
pack-priv static final String	SUBSTITUTE_LOGGER_URL
pack-priv static final int	SUCCESSFUL_INITIALIZATION
pack-priv static final int	UNINITIALIZED
pack-priv static final String	UNSUCCESSFUL_INIT_MSG
pack-priv static final String	UNSUCCESSFUL_INIT_URL
pack-priv static final String	VERSION_MISMATCH

Constructor Summary

Access	Constructor and Description
private	LoggerFactory()

Method Summary

Modifier and Type	Method and Description
private static final void	bind()
private static void	earlyBindMDCAdapter() The value of PROVIDER.getMDCAdapter() can be null while PROVIDER has not yet initialized.
private static void	emitReplayOrSubstituionWarning(SubstituteLoggingEvent event, int queueSize)
private static void	emitReplayWarning(int eventCount)
private static void	emitSubstitutionWarning()
pack-priv static void	failedBinding(Throwable t)
pack-priv static Set<URL>	findPossibleStaticLoggerBinderPathSet()
pack-priv static List<SLF4JServiceProvider>	findServiceProviders()
private static void	fixSubstituteLoggers()
public static ILoggerFactory	Returns: the ILoggerFactory instance in use getILoggerFactory() Return the `ILoggerFactory` instance in use.
public static Logger	Returns: logger getLogger(String The name of the logger. name) Return a logger named according to the name parameter using the statically bound `ILoggerFactory` instance.
public static Logger	Returns: logger getLogger(Class<?> the returned logger will be named after clazz clazz) Return a logger named corresponding to the class passed as parameter, using the statically bound `ILoggerFactory` instance.
pack-priv static SLF4JServiceProvider	Returns: provider in use getProvider() Return the `SLF4JServiceProvider` in use.
private static ServiceLoader<SLF4JServiceProvider>	getServiceLoader(final ClassLoader classLoaderOfLoggerFactory)
private static boolean	isAmbiguousProviderList(List<SLF4JServiceProvider> providerList)
pack-priv static SLF4JServiceProvider	loadExplicitlySpecified(ClassLoader classLoader)
private static boolean	nonMatchingClasses(Class<?> clazz, Class<?> autoComputedCallingClass)
private static final void	performInitialization()
private static void	postBindCleanUp()
private static void	replayEvents()
private static void	replaySingleEvent(SubstituteLoggingEvent event)
private static void	reportActualBinding(List<SLF4JServiceProvider> providerList)
private static void	reportIgnoredStaticLoggerBinders(Set<URL> staticLoggerBinderPathSet)
private static void	reportMultipleBindingAmbiguity(List<SLF4JServiceProvider> providerList) Prints a warning message on the console if multiple bindings were found on the class path.
pack-priv static void	reset() Force LoggerFactory to consider itself uninitialized.
private static void	safelyInstantiate(List<SLF4JServiceProvider> providerList, Iterator<SLF4JServiceProvider> iterator)
private static final void	versionSanityCheck()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

API_COMPATIBILITY_LIST	back to summary
private static final String[] API_COMPATIBILITY_LIST It is LoggerFactory's responsibility to track version changes and manage the compatibility list.

API_COMPATIBILITY_LIST

back to summary

private static final String[] API_COMPATIBILITY_LIST

It is LoggerFactory's responsibility to track version changes and manage the compatibility list.

CODES_PREFIX	back to summary
pack-priv static final String CODES_PREFIX

CONNECTED_WITH_MSG	back to summary
pack-priv static final String CONNECTED_WITH_MSG

DETECT_LOGGER_NAME_MISMATCH	back to summary
pack-priv static boolean DETECT_LOGGER_NAME_MISMATCH

DETECT_LOGGER_NAME_MISMATCH_PROPERTY	back to summary
pack-priv static final String DETECT_LOGGER_NAME_MISMATCH_PROPERTY

FAILED_INITIALIZATION	back to summary
pack-priv static final int FAILED_INITIALIZATION

IGNORED_BINDINGS_URL	back to summary
pack-priv static final String IGNORED_BINDINGS_URL

INITIALIZATION_STATE	back to summary
pack-priv static volatile int INITIALIZATION_STATE

JAVA_VENDOR_PROPERTY	back to summary
pack-priv static final String JAVA_VENDOR_PROPERTY

LOGGER_NAME_MISMATCH_URL	back to summary
pack-priv static final String LOGGER_NAME_MISMATCH_URL

MULTIPLE_BINDINGS_URL	back to summary
pack-priv static final String MULTIPLE_BINDINGS_URL

NO_PROVIDERS_URL	back to summary
pack-priv static final String NO_PROVIDERS_URL

NOP_FALLBACK_INITIALIZATION	back to summary
pack-priv static final int NOP_FALLBACK_INITIALIZATION

NOP_FALLBACK_SERVICE_PROVIDER	back to summary
pack-priv static final NOP_FallbackServiceProvider NOP_FALLBACK_SERVICE_PROVIDER

ONGOING_INITIALIZATION	back to summary
pack-priv static final int ONGOING_INITIALIZATION

PROVIDER	back to summary
pack-priv static volatile SLF4JServiceProvider PROVIDER

PROVIDER_PROPERTY_KEY	back to summary
public static final String PROVIDER_PROPERTY_KEY System property for explicitly setting the provider class. If set and the provider could be instantiated, then the service loading mechanism will be bypassed. Since 2.0.9

PROVIDER_PROPERTY_KEY

back to summary

public static final String PROVIDER_PROPERTY_KEY

System property for explicitly setting the provider class. If set and the provider could be instantiated, then the service loading mechanism will be bypassed.

Since: 2.0.9

REPLAY_URL	back to summary
pack-priv static final String REPLAY_URL

STATIC_LOGGER_BINDER_PATH	back to summary
private static final String STATIC_LOGGER_BINDER_PATH

SUBST_PROVIDER	back to summary
pack-priv static final SubstituteServiceProvider SUBST_PROVIDER

SUBSTITUTE_LOGGER_URL	back to summary
pack-priv static final String SUBSTITUTE_LOGGER_URL

SUCCESSFUL_INITIALIZATION	back to summary
pack-priv static final int SUCCESSFUL_INITIALIZATION

UNINITIALIZED	back to summary
pack-priv static final int UNINITIALIZED

UNSUCCESSFUL_INIT_MSG	back to summary
pack-priv static final String UNSUCCESSFUL_INIT_MSG

UNSUCCESSFUL_INIT_URL	back to summary
pack-priv static final String UNSUCCESSFUL_INIT_URL

VERSION_MISMATCH	back to summary
pack-priv static final String VERSION_MISMATCH

Constructor Detail

LoggerFactory	back to summary
private LoggerFactory()

Method Detail

bind	back to summary
private static final void bind()

earlyBindMDCAdapter	back to summary
private static void earlyBindMDCAdapter() The value of PROVIDER.getMDCAdapter() can be null while PROVIDER has not yet initialized. However, SLF4JServiceProvider implementations are expected to initialize their internal MDCAdapter field in their constructor or on field declaration.

emitReplayOrSubstituionWarning	back to summary
private static void emitReplayOrSubstituionWarning(SubstituteLoggingEvent event, int queueSize)

emitReplayWarning	back to summary
private static void emitReplayWarning(int eventCount)

emitSubstitutionWarning	back to summary
private static void emitSubstitutionWarning()

failedBinding	back to summary
pack-priv static void failedBinding(Throwable t)

findPossibleStaticLoggerBinderPathSet	back to summary
pack-priv static Set<URL> findPossibleStaticLoggerBinderPathSet()

findServiceProviders	back to summary
pack-priv static List<SLF4JServiceProvider> findServiceProviders()

fixSubstituteLoggers	back to summary
private static void fixSubstituteLoggers()

getILoggerFactory back to summary

getILoggerFactory	back to summary
public static ILoggerFactory getILoggerFactory() Return the `ILoggerFactory` instance in use. ILoggerFactory instance is bound with this class at compile time. Returns:ILoggerFactory the ILoggerFactory instance in use

public static ILoggerFactory getILoggerFactory()

Return the ILoggerFactory instance in use.

ILoggerFactory instance is bound with this class at compile time.

Returns:ILoggerFactory: the ILoggerFactory instance in use

getLogger back to summary

getLogger	back to summary
public static Logger getLogger(String name) Return a logger named according to the name parameter using the statically bound `ILoggerFactory` instance. Parameters name:String The name of the logger. Returns:Logger logger

public static Logger getLogger(String name)

Return a logger named according to the name parameter using the statically bound ILoggerFactory instance.

Parameters

name:String: The name of the logger.

Returns:Logger

logger

getLogger back to summary

getLogger	back to summary
public static Logger getLogger(Class<?> clazz) Return a logger named corresponding to the class passed as parameter, using the statically bound `ILoggerFactory` instance. In case the `clazz` parameter differs from the name of the caller as computed internally by SLF4J, a logger name mismatch warning will be printed but only if the `slf4j.detectLoggerNameMismatch` system property is set to true. By default, this property is not set and no warnings will be printed even in case of a logger name mismatch. Parameters clazz:Class<?> the returned logger will be named after clazz Returns:Logger logger See Also Detected logger name mismatch

public static Logger getLogger(Class<?> clazz)

Return a logger named corresponding to the class passed as parameter, using the statically bound ILoggerFactory instance.

In case the clazz parameter differs from the name of the caller as computed internally by SLF4J, a logger name mismatch warning will be printed but only if the slf4j.detectLoggerNameMismatch system property is set to true. By default, this property is not set and no warnings will be printed even in case of a logger name mismatch.

Parameters

clazz:Class<?>: the returned logger will be named after clazz

Returns:Logger

logger

See Also

Detected logger name mismatch

getProvider back to summary

getProvider	back to summary
pack-priv static SLF4JServiceProvider getProvider() Return the `SLF4JServiceProvider` in use. Returns:SLF4JServiceProvider provider in use Since 1.8.0

pack-priv static SLF4JServiceProvider getProvider()

Return the SLF4JServiceProvider in use.

Returns:SLF4JServiceProvider: provider in use
Since: 1.8.0

getServiceLoader	back to summary
private static ServiceLoader<SLF4JServiceProvider> getServiceLoader(final ClassLoader classLoaderOfLoggerFactory)

isAmbiguousProviderList	back to summary
private static boolean isAmbiguousProviderList(List<SLF4JServiceProvider> providerList)

loadExplicitlySpecified	back to summary
pack-priv static SLF4JServiceProvider loadExplicitlySpecified(ClassLoader classLoader)

nonMatchingClasses	back to summary
private static boolean nonMatchingClasses(Class<?> clazz, Class<?> autoComputedCallingClass)

performInitialization	back to summary
private static final void performInitialization()

postBindCleanUp	back to summary
private static void postBindCleanUp()

replayEvents	back to summary
private static void replayEvents()

replaySingleEvent	back to summary
private static void replaySingleEvent(SubstituteLoggingEvent event)

reportActualBinding	back to summary
private static void reportActualBinding(List<SLF4JServiceProvider> providerList)

reportIgnoredStaticLoggerBinders	back to summary
private static void reportIgnoredStaticLoggerBinders(Set<URL> staticLoggerBinderPathSet)

reportMultipleBindingAmbiguity	back to summary
private static void reportMultipleBindingAmbiguity(List<SLF4JServiceProvider> providerList) Prints a warning message on the console if multiple bindings were found on the class path. No reporting is done otherwise.

reset

back to summary

pack-priv static void reset()

Force LoggerFactory to consider itself uninitialized.

This method is intended to be called by classes (in the same package) for testing purposes. This method is internal. It can be modified, renamed or removed at any time without notice.

You are strongly discouraged from calling this method in production code.

safelyInstantiate	back to summary
private static void safelyInstantiate(List<SLF4JServiceProvider> providerList, Iterator<SLF4JServiceProvider> iterator)

versionSanityCheck	back to summary
private static final void versionSanityCheck()

public final Class LoggerFactory

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail