Package org.apache.log
Class Logger
java.lang.Object
org.apache.log.Logger
The object interacted with by client objects to perform logging.
- Author:
- Avalon Development Team, Peter Donald
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final char
Separator character use to separate different categoriesprivate static final Logger[]
private boolean
True means LogEvents will be sent to parents LogTargets aswell as the ones set for this Logger.private final String
private Logger[]
private final ErrorHandler
private final LoggerListener
private LogTarget[]
private boolean
private final Logger
private Priority
private boolean
-
Constructor Summary
ConstructorsConstructorDescriptionLogger
(ErrorHandler errorHandler, LoggerListener loggerListener, String category, LogTarget[] logTargets, Logger parent) Protected constructor for use inside the logging toolkit. -
Method Summary
Modifier and TypeMethodDescriptionfinal void
Log a debug priority event.final void
Log a debug priority event.final void
Log a error priority event.final void
Log a error priority event.final void
fatalError
(String message) Log a fatalError priority event.final void
fatalError
(String message, Throwable throwable) Log a fatalError priority event.private final void
getChildLogger
(String subCategory) Create a new child logger.Logger[]
Get all the child Loggers of current logger.final void
Log a info priority event.final void
Log a info priority event.final boolean
Determine if messages of priority DEBUG will be logged.final boolean
Determine if messages of priority ERROR will be logged.final boolean
Determine if messages of priority FATAL_ERROR will be logged.final boolean
Determine if messages of priority INFO will be logged.final boolean
isPriorityEnabled
(Priority priority) Determine if messages of priority �will be logged.final boolean
Determine if messages of priority WARN will be logged.final void
Log a event at specific priority with a certain message.final void
Log a event at specific priority with a certain message and throwable.private final void
private final void
Internal method to do actual outputting.private void
resetChildLogTargets
(boolean recursive) Update logTargets of children if any.private void
resetChildPriorities
(boolean recursive) Update priority of children if any.private void
resetLogTargets
(boolean recursive) Update logTarget of this Logger.private void
resetPriority
(boolean recursive) Update priority of this Logger.private LogTarget[]
Retrieve logtarget array contained in logger.final void
setAdditivity
(boolean additivity) Make this logger additive.void
setLogTargets
(LogTarget[] logTargets) Set the log targets for this logger.void
setPriority
(Priority priority) Set the priority for this logger.private void
Set ErrorHandlers of LogTargets if necessary.void
Unset the logtargets for this logger.void
unsetLogTargets
(boolean recursive) Unset the logtargets for this logger and all child loggers if recursive is set.void
Unset the priority of Logger.void
unsetPriority
(boolean recursive) Unset the priority of Logger.final void
Log a warn priority event.final void
Log a warn priority event.
-
Field Details
-
EMPTY_SET
-
CATEGORY_SEPARATOR
public static final char CATEGORY_SEPARATORSeparator character use to separate different categories- See Also:
-
m_errorHandler
-
m_loggerListener
-
m_parent
-
m_category
-
m_children
-
m_logTargets
-
m_logTargetsForceSet
private boolean m_logTargetsForceSet -
m_priority
-
m_priorityForceSet
private boolean m_priorityForceSet -
m_additivity
private boolean m_additivityTrue means LogEvents will be sent to parents LogTargets aswell as the ones set for this Logger.
-
-
Constructor Details
-
Logger
Logger(ErrorHandler errorHandler, LoggerListener loggerListener, String category, LogTarget[] logTargets, Logger parent) Protected constructor for use inside the logging toolkit. You should not be using this constructor directly.- Parameters:
errorHandler
- the ErrorHandler logger uses to log errorscategory
- the fully qualified name of categorylogTargets
- the LogTargets associated with loggerparent
- the parent logger (used for inheriting from)
-
-
Method Details
-
isDebugEnabled
public final boolean isDebugEnabled()Determine if messages of priority DEBUG will be logged.- Returns:
- true if DEBUG messages will be logged
-
debug
Log a debug priority event.- Parameters:
message
- the messagethrowable
- the throwable
-
debug
Log a debug priority event.- Parameters:
message
- the message
-
isInfoEnabled
public final boolean isInfoEnabled()Determine if messages of priority INFO will be logged.- Returns:
- true if INFO messages will be logged
-
info
Log a info priority event.- Parameters:
message
- the messagethrowable
- the throwable
-
info
Log a info priority event.- Parameters:
message
- the message
-
isWarnEnabled
public final boolean isWarnEnabled()Determine if messages of priority WARN will be logged.- Returns:
- true if WARN messages will be logged
-
warn
Log a warn priority event.- Parameters:
message
- the messagethrowable
- the throwable
-
warn
Log a warn priority event.- Parameters:
message
- the message
-
isErrorEnabled
public final boolean isErrorEnabled()Determine if messages of priority ERROR will be logged.- Returns:
- true if ERROR messages will be logged
-
error
Log a error priority event.- Parameters:
message
- the messagethrowable
- the throwable
-
error
Log a error priority event.- Parameters:
message
- the message
-
isFatalErrorEnabled
public final boolean isFatalErrorEnabled()Determine if messages of priority FATAL_ERROR will be logged.- Returns:
- true if FATAL_ERROR messages will be logged
-
fatalError
Log a fatalError priority event.- Parameters:
message
- the messagethrowable
- the throwable
-
fatalError
Log a fatalError priority event.- Parameters:
message
- the message
-
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.- Parameters:
additivity
- true to make logger additive, false otherwise
-
isPriorityEnabled
Determine if messages of priority �will be logged.- Parameters:
priority
- the priority- Returns:
- true if messages will be logged
-
log
Log a event at specific priority with a certain message and throwable.- Parameters:
priority
- the prioritymessage
- the messagethrowable
- the throwable
-
log
Log a event at specific priority with a certain message.- Parameters:
priority
- the prioritymessage
- the message
-
setPriority
Set the priority for this logger.- Parameters:
priority
- the priority
-
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.- Parameters:
recursive
- true to unset priority of all child loggers
-
setLogTargets
Set the log targets for this logger.- Parameters:
logTargets
- the Log Targets
-
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.- Parameters:
recursive
- the recursion policy
-
getChildren
Get all the child Loggers of current logger.- Returns:
- the child loggers
-
getChildLogger
Create a new child logger. The category of child logger is [current-category].subcategory- Parameters:
subCategory
- the subcategory of this logger- Returns:
- the new logger
- Throws:
IllegalArgumentException
- if subCategory has an empty element name
-
output
Internal method to do actual outputting.- Parameters:
priority
- the prioritymessage
- the messagethrowable
- the throwable
-
output
-
fireEvent
-
resetChildPriorities
private void resetChildPriorities(boolean recursive) Update priority of children if any. -
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
Retrieve logtarget array contained in logger. This method is provided so that child Loggers can access a copy of parents LogTargets.- Returns:
- the array of LogTargets
-
resetChildLogTargets
private void resetChildLogTargets(boolean recursive) Update logTargets of children if any. -
setupErrorHandlers
private void setupErrorHandlers()Set ErrorHandlers of LogTargets if necessary. -
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.
-