The object interacted with by client objects to perform logging.
CATEGORY_SEPARATOR
public static final char CATEGORY_SEPARATOR
Separator character use to separate different categories
EMPTY_SET
private static final Logger[] EMPTY_SET
m_additivity
private boolean m_additivity
True means LogEvents will be sent to parents LogTargets
aswell as the ones set for this Logger.
m_category
private final String m_category
m_children
private Logger[] m_children
m_logTargetsForceSet
private boolean m_logTargetsForceSet
m_parent
private final Logger m_parent
m_priorityForceSet
private boolean m_priorityForceSet
debug
public final void debug(String message)
Log a debug priority event.
debug
public final void debug(String message,
Throwable throwable)
Log a debug priority event.
message
- the messagethrowable
- the throwable
error
public final void error(String message)
Log a error priority event.
error
public final void error(String message,
Throwable throwable)
Log a error priority event.
message
- the messagethrowable
- the throwable
fatalError
public final void fatalError(String message)
Log a fatalError priority event.
fatalError
public final void fatalError(String message,
Throwable throwable)
Log a fatalError priority event.
message
- the messagethrowable
- the throwable
getChildLogger
public Logger getChildLogger(String subCategory)
throws IllegalArgumentException
Create a new child logger.
The category of child logger is [current-category].subcategory
subCategory
- the subcategory of this logger
getChildren
public Logger[] getChildren()
Get all the child Loggers of current logger.
info
public final void info(String message)
Log a info priority event.
info
public final void info(String message,
Throwable throwable)
Log a info priority event.
message
- the messagethrowable
- the throwable
isDebugEnabled
public final boolean isDebugEnabled()
Determine if messages of priority DEBUG will be logged.
- true if DEBUG messages will be logged
isErrorEnabled
public final boolean isErrorEnabled()
Determine if messages of priority ERROR will be logged.
- true if ERROR messages will be logged
isFatalErrorEnabled
public final boolean isFatalErrorEnabled()
Determine if messages of priority FATAL_ERROR will be logged.
- true if FATAL_ERROR messages will be logged
isInfoEnabled
public final boolean isInfoEnabled()
Determine if messages of priority INFO will be logged.
- true if INFO messages will be logged
isPriorityEnabled
public final boolean isPriorityEnabled(Priority priority)
Determine if messages of priority ???will be logged.
- true if messages will be logged
isWarnEnabled
public final boolean isWarnEnabled()
Determine if messages of priority WARN will be logged.
- true if WARN messages will be logged
log
public final void log(Priority priority,
String message)
Log a event at specific priority with a certain message.
priority
- the prioritymessage
- the message
log
public final void log(Priority priority,
String message,
Throwable throwable)
Log a event at specific priority with a certain message and throwable.
priority
- the prioritymessage
- the messagethrowable
- the throwable
output
private final void output(LogEvent event)
output
private final void output(Priority priority,
String message,
Throwable throwable)
Internal method to do actual outputting.
priority
- the prioritymessage
- the messagethrowable
- the throwable
resetChildLogTargets
private void resetChildLogTargets(boolean recursive)
Update logTargets of children if any.
resetChildPriorities
private void resetChildPriorities(boolean recursive)
Update priority of children if any.
resetLogTargets
private void resetLogTargets(boolean recursive)
Update logTarget of this Logger.
If this loggers logTarget was manually set then ignore
otherwise get parents logTarget and update all children's logTarget.
resetPriority
private void resetPriority(boolean recursive)
Update priority of this Logger.
If this loggers priority was manually set then ignore
otherwise get parents priority and update all children's priority.
safeGetLogTargets
private LogTarget[] safeGetLogTargets()
Retrieve logtarget array contained in logger.
This method is provided so that child Loggers can access a
copy of parents LogTargets.
setAdditivity
public final void setAdditivity(boolean additivity)
Make this logger additive. I.e. Send all log events to parent
loggers LogTargets regardless of whether or not the
LogTargets have been overidden.
This is derived from Log4js notion of Additivity.
additivity
- true to make logger additive, false otherwise
setLogTargets
public void setLogTargets(LogTarget[] logTargets)
Set the log targets for this logger.
logTargets
- the Log Targets
setPriority
public void setPriority(Priority priority)
Set the priority for this logger.
setupErrorHandlers
private void setupErrorHandlers()
Set ErrorHandlers of LogTargets if necessary.
unsetLogTargets
public void unsetLogTargets()
Unset the logtargets for this logger.
This logger (and thus all child loggers who don't specify logtargets) will
inherit from the parents LogTargets.
unsetLogTargets
public void unsetLogTargets(boolean recursive)
Unset the logtargets for this logger and all child loggers if recursive is set.
The loggers unset (and all child loggers who don't specify logtargets) will
inherit from the parents LogTargets.
recursive
- the recursion policy
unsetPriority
public void unsetPriority()
Unset the priority of Logger.
(Thus it will use it's parent's priority or DEBUG if no parent.
unsetPriority
public void unsetPriority(boolean recursive)
Unset the priority of Logger.
(Thus it will use it's parent's priority or DEBUG if no parent.
If recursive is true unset priorities of all child loggers.
recursive
- true to unset priority of all child loggers
warn
public final void warn(String message)
Log a warn priority event.
warn
public final void warn(String message,
Throwable throwable)
Log a warn priority event.
message
- the messagethrowable
- the throwable