org.apache.log4j
public class Hierarchy extends Object implements LoggerRepository, RendererSupport
The casual user does not have to deal with this class directly.
The structure of the logger hierarchy is maintained by the {@link #getLogger} method. The hierarchy is such that children link to their parent but parents do not have any pointers to their children. Moreover, loggers can be instantiated in any order, in particular descendant before ancestor.
In case a descendant is created before a particular ancestor, then it creates a provision node for the ancestor and adds itself to the provision node. Other descendants of the same ancestor add themselves to the previously created provision node.
Constructor Summary | |
---|---|
Hierarchy(Logger root)
Create a new logger hierarchy. |
Method Summary | |
---|---|
void | addHierarchyEventListener(HierarchyEventListener listener) |
void | addRenderer(Class classToRender, ObjectRenderer or)
Add an object renderer for a specific class. |
void | clear()
This call will clear all logger definitions from the internal
hashtable. |
void | emitNoAppenderWarning(Category cat) |
Logger | exists(String name)
Check if the named logger exists in the hierarchy. |
void | fireAddAppenderEvent(Category logger, Appender appender) |
Enumeration | getCurrentCategories() |
Enumeration | getCurrentLoggers()
Returns all the currently defined categories in this hierarchy as
an {@link java.util.Enumeration Enumeration}.
|
Logger | getLogger(String name)
Return a new logger instance named as the first parameter using
the default factory.
|
Logger | getLogger(String name, LoggerFactory factory)
Return a new logger instance named as the first parameter using
factory .
|
RendererMap | getRendererMap()
Get the renderer map for this hierarchy. |
Logger | getRootLogger()
Get the root of this hierarchy. |
Level | getThreshold()
Returns a {@link Level} representation of the enable
state. |
boolean | isDisabled(int level)
This method will return true if this repository is
disabled for level object passed as parameter and
false otherwise. |
void | overrideAsNeeded(String override) |
void | resetConfiguration()
Reset all values contained in this hierarchy instance to their
default. |
void | setDisableOverride(String override)
Does mothing. |
void | setRenderer(Class renderedClass, ObjectRenderer renderer)
Used by subclasses to add a renderer to the hierarchy passed as parameter. |
void | setThreshold(String levelStr)
The string form of {@link #setThreshold(Level)}. |
void | setThreshold(Level l)
Enable logging for logging requests with level l or
higher. |
void | shutdown()
Shutting down a hierarchy will safely close and remove
all appenders in all categories including the root logger.
|
Parameters: root The root of the new hierarchy.
You should really know what you are doing before invoking this method.
Since: 0.9.0
null
.Parameters: name The name of the logger to search for.
Deprecated: Please use {@link #getCurrentLoggers} instead.
The root logger is not included in the returned {@link Enumeration}.
If a logger of that name already exists, then it will be returned. Otherwise, a new logger will be instantiated and then linked with its existing ancestors as well as children.
Parameters: name The name of the logger to retrieve.
factory
.
If a logger of that name already exists, then it will be
returned. Otherwise, a new logger will be instantiated by the
factory
parameter and linked with its existing
ancestors as well as children.
Parameters: name The name of the logger to retrieve. factory The factory that will make the new logger instance.
Since: 0.9.0
enable
state.Since: 1.2
true
if this repository is
disabled for level
object passed as parameter and
false
otherwise. See also the {@link
#setThreshold(Level) threshold} emthod.Deprecated: Deprecated with no replacement.
null
,
sets their additivity flag to true
and sets the level
of the root logger to {@link Level#DEBUG DEBUG}. Moreover,
message disabling is set its default "off" value.
Existing categories are not removed. They are just reset.
This method should be used sparingly and with care as it will block all logging until it is completed.
Since: 0.8.5
Deprecated: Deprecated with no replacement.
Does mothing.l
or
higher. By default all levels are enabled.Parameters: l The minimum level for which logging requests are sent to their appenders.
Some appenders such as {@link org.apache.log4j.net.SocketAppender} and {@link AsyncAppender} need to be closed before the application exists. Otherwise, pending logging events might be lost.
The shutdown
method is careful to close nested
appenders before closing regular appenders. This is allows
configurations where a regular appender is attached to a logger
and again to a nested appender.
Since: 1.0