org.znerd.logdoc

Class Library

java.lang.Object

org.znerd.logdoc.Library

public final class Library
extends Object

Class that represents the Logdoc library.

When this class is run as a program, then it prints the name and version (if known) of this library to standard out.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_LOCALE

Method Summary

Methods

Modifier and Type	Method and Description
static String	getLocale() Get the current locale.
static LogBridge	getLogBridge() Get the current logging bridge.
static LogFilter	getLogFilter() Returns the active LogFilter.
static InputStream	getMetaResourceAsStream(String path) Retrieves a meta resource and returns it as an InputStream.
static String	getName() Returns the official human-readable name of this library.
static String	getVersion() Returns the version of this library.
static boolean	isStackTraceAtMessageLevel() Indicates whether the stack trace should be displayed at the same level as the message.
static void	main(String[] args)
static void	resetLogBridge()
static void	setLocale(String newLocale) Sets the locale for the complete Logdoc library.
static void	setLogBridge(LogBridge logBridge) Sets the logging bridge to be used.
static void	setLogFilter(LogFilter logFilter) Sets the current log filter.
static void	setLogFilterByClassName(String className) Set the active LogFilter by class name.
static void	setStackTraceAtMessageLevel(boolean sameLevel) Enables or disables the display of the stack trace at the same level as the message.
static void	useDefaultLocale() Sets the locale on all logdoc Log classes to the default locale.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_LOCALE

public static final String DEFAULT_LOCALE

Method Detail

main

public static final void main(String[] args)

getName

public static final String getName()

Returns the official human-readable name of this library.

Returns:

the name, for example "Logdoc", never null.

getVersion

public static final String getVersion()

Returns the version of this library.

Returns:

the version of this library, for example "3.0", or null if unknown.

setLocale

public static void setLocale(String newLocale)
                      throws UnsupportedLocaleException

Sets the locale for the complete Logdoc library.

Parameters:

newLocale - the new locale, cannot be null.

Throws:

UnsupportedLocaleException - if the specified locale is not supported by all registered Log classes.

useDefaultLocale

public static void useDefaultLocale()

Sets the locale on all logdoc Log classes to the default locale.

getLocale

public static String getLocale()

Get the current locale.

Returns:

the locale, e.g. "fr_FR"; never null.

resetLogBridge

public static void resetLogBridge()

getLogBridge

public static LogBridge getLogBridge()

Get the current logging bridge.

Returns:

the logging bridge, never null.

setLogBridge

public static void setLogBridge(LogBridge logBridge)

Sets the logging bridge to be used.

Parameters:

logBridge - the LogBridge to use, cannot be null.

setStackTraceAtMessageLevel

public static void setStackTraceAtMessageLevel(boolean sameLevel)

Enables or disables the display of the stack trace at the same level as the message.

Parameters:

sameLevel - true if the stack trace should be at the same level, false if the stack trace should be at LOG4J_DEBUG_LEVEL level.

isStackTraceAtMessageLevel

public static boolean isStackTraceAtMessageLevel()

Indicates whether the stack trace should be displayed at the same level as the message.

Returns:

true if the stack trace should be at the same level, false if the stack trace should be at LOG4J_DEBUG_LEVEL level.

setLogFilter

public static void setLogFilter(LogFilter logFilter)

Sets the current log filter.

Parameters:

logFilter - the new LogFilter, cannot be null.

setLogFilterByClassName

public static void setLogFilterByClassName(String className)
                                    throws InstantiationException,
                                           IllegalAccessException,
                                           ClassNotFoundException

Set the active LogFilter by class name. If the parameter is null then an exception is thrown. Otherwise if an instance cannot be constructed, then an instance of class NullLogFilter is used instead.

Parameters:

className - the name of the LogFilter class to use, cannot be null.

Throws:

InstantiationException

IllegalAccessException

ClassNotFoundException

getLogFilter

public static LogFilter getLogFilter()

Returns the active LogFilter.

Returns:

the current LogFilter, never null.

getMetaResourceAsStream

public static InputStream getMetaResourceAsStream(String path)
                                           throws NoSuchResourceException,
                                                  IOException

Retrieves a meta resource and returns it as an InputStream. Calling this function will not trigger initialization of the library.

Parameters:

path - the path to the meta resource, cannot be null.

Returns:

the resource as an InputStream.

Throws:

NoSuchResourceException - if the resource could not be found.

IOException - if the stream could not be opened.