Avalon Logkit 2.2.1 · org.apache.log.Logger

Modifier and Type	Field and Description
public static final char	CATEGORY_SEPARATOR Separator character use to separate different categories
private static final Logger[]	EMPTY_SET
private boolean	m_additivity True means LogEvents will be sent to parents LogTargets aswell as the ones set for this Logger.
private final String	m_category
private Logger[]	m_children
private final ErrorHandler	m_errorHandler
private final LoggerListener	m_loggerListener
private LogTarget[]	m_logTargets
private boolean	m_logTargetsForceSet
private final Logger	m_parent
private Priority	m_priority
private boolean	m_priorityForceSet

Access	Constructor and Description
pack-priv	Logger(final ErrorHandler the ErrorHandler logger uses to log errors errorHandler, final LoggerListener loggerListener, final String the fully qualified name of category category, final LogTarget[] the LogTargets associated with logger logTargets, final Logger the parent logger (used for inheriting from) parent) Protected constructor for use inside the logging toolkit.

Method Summary

Modifier and Type	Method and Description
public final void	debug(final String the message message, final Throwable the throwable throwable) Log a debug priority event.
public final void	debug(final String the message message) Log a debug priority event.
public final void	error(final String the message message, final Throwable the throwable throwable) Log a error priority event.
public final void	error(final String the message message) Log a error priority event.
public final void	fatalError(final String the message message, final Throwable the throwable throwable) Log a fatalError priority event.
public final void	fatalError(final String the message message) Log a fatalError priority event.
private final void	fireEvent(final LogEvent event, final LogTarget[] targets)
public synchronized Logger	Returns: the new logger getChildLogger(final String the subcategory of this logger subCategory) Create a new child logger.
public synchronized Logger[]	Returns: the child loggers getChildren() Get all the child Loggers of current logger.
public final void	info(final String the message message, final Throwable the throwable throwable) Log a info priority event.
public final void	info(final String the message message) Log a info priority event.
public final boolean	Returns: true if DEBUG messages will be logged isDebugEnabled() Determine if messages of priority DEBUG will be logged.
public final boolean	Returns: true if ERROR messages will be logged isErrorEnabled() Determine if messages of priority ERROR will be logged.
public final boolean	Returns: true if FATAL_ERROR messages will be logged isFatalErrorEnabled() Determine if messages of priority FATAL_ERROR will be logged.
public final boolean	Returns: true if INFO messages will be logged isInfoEnabled() Determine if messages of priority INFO will be logged.
public final boolean	Returns: true if messages will be logged isPriorityEnabled(final Priority the priority priority) Determine if messages of priority �will be logged.
public final boolean	Returns: true if WARN messages will be logged isWarnEnabled() Determine if messages of priority WARN will be logged.
public final void	log(final Priority the priority priority, final String the message message, final Throwable the throwable throwable) Log a event at specific priority with a certain message and throwable.
public final void	log(final Priority the priority priority, final String the message message) Log a event at specific priority with a certain message.
private final void	output(final Priority the priority priority, final String the message message, final Throwable the throwable throwable) Internal method to do actual outputting.
private final void	output(final LogEvent event)
private synchronized void	resetChildLogTargets(final boolean recursive) Update logTargets of children if any.
private synchronized void	resetChildPriorities(final boolean recursive) Update priority of children if any.
private synchronized void	resetLogTargets(final boolean recursive) Update logTarget of this Logger.
private synchronized void	resetPriority(final boolean recursive) Update priority of this Logger.
private synchronized LogTarget[]	Returns: the array of LogTargets safeGetLogTargets() Retrieve logtarget array contained in logger.
public final void	setAdditivity(final boolean true to make logger additive, false otherwise additivity) Make this logger additive.
public synchronized void	setLogTargets(final LogTarget[] the Log Targets logTargets) Set the log targets for this logger.
public synchronized void	setPriority(final Priority the priority priority) Set the priority for this logger.
private synchronized void	setupErrorHandlers() Set ErrorHandlers of LogTargets if necessary.
public synchronized void	unsetLogTargets() Unset the logtargets for this logger.
public synchronized void	unsetLogTargets(final boolean the recursion policy recursive) Unset the logtargets for this logger and all child loggers if recursive is set.
public synchronized void	unsetPriority() Unset the priority of Logger.
public synchronized void	unsetPriority(final boolean true to unset priority of all child loggers recursive) Unset the priority of Logger.
public final void	warn(final String the message message, final Throwable the throwable throwable) Log a warn priority event.
public final void	warn(final String the message message) Log a warn priority event.

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

CATEGORY_SEPARATOR	back to summary
public static final char CATEGORY_SEPARATOR Separator character use to separate different categories

EMPTY_SET	back to summary
private static final Logger[] EMPTY_SET

m_additivity	back to summary
private boolean m_additivity True means LogEvents will be sent to parents LogTargets aswell as the ones set for this Logger.

m_category	back to summary
private final String m_category

m_children	back to summary
private Logger[] m_children

m_errorHandler	back to summary
private final ErrorHandler m_errorHandler

m_loggerListener	back to summary
private final LoggerListener m_loggerListener

m_logTargets	back to summary
private LogTarget[] m_logTargets

m_logTargetsForceSet	back to summary
private boolean m_logTargetsForceSet

m_parent	back to summary
private final Logger m_parent

m_priority	back to summary
private Priority m_priority

m_priorityForceSet	back to summary
private boolean m_priorityForceSet

Logger	back to summary
pack-priv Logger(final ErrorHandler errorHandler, final LoggerListener loggerListener, final String category, final LogTarget[] logTargets, final Logger parent) Protected constructor for use inside the logging toolkit. You should not be using this constructor directly. Parameters errorHandler:ErrorHandler the ErrorHandler logger uses to log errors category:String the fully qualified name of category logTargets:LogTarget[] the LogTargets associated with logger parent:Logger the parent logger (used for inheriting from)

Method Detail

debug	back to summary
public final void debug(final String message, final Throwable throwable) Log a debug priority event. Parameters message:String the message throwable:Throwable the throwable

debug

back to summary

public final void debug(final String message, final Throwable throwable)

Log a debug priority event.

Parameters

message:String: the message
throwable:Throwable: the throwable

debug	back to summary
public final void debug(final String message) Log a debug priority event. Parameters message:String the message

debug

back to summary

public final void debug(final String message)

Log a debug priority event.

Parameters

message:String: the message

error	back to summary
public final void error(final String message, final Throwable throwable) Log a error priority event. Parameters message:String the message throwable:Throwable the throwable

error

back to summary

public final void error(final String message, final Throwable throwable)

Log a error priority event.

Parameters

message:String: the message
throwable:Throwable: the throwable

error	back to summary
public final void error(final String message) Log a error priority event. Parameters message:String the message

error

back to summary

public final void error(final String message)

Log a error priority event.

Parameters

message:String: the message

fatalError	back to summary
public final void fatalError(final String message, final Throwable throwable) Log a fatalError priority event. Parameters message:String the message throwable:Throwable the throwable

fatalError

back to summary

public final void fatalError(final String message, final Throwable throwable)

Log a fatalError priority event.

Parameters

message:String: the message
throwable:Throwable: the throwable

fatalError	back to summary
public final void fatalError(final String message) Log a fatalError priority event. Parameters message:String the message

fatalError

back to summary

public final void fatalError(final String message)

Log a fatalError priority event.

Parameters

message:String: the message

fireEvent	back to summary
private final void fireEvent(final LogEvent event, final LogTarget[] targets)

getChildLogger	back to summary
public synchronized Logger getChildLogger(final String subCategory) throws IllegalArgumentException Create a new child logger. The category of child logger is [current-category].subcategory Parameters subCategory:String the subcategory of this logger Returns:Logger the new logger Exceptions IllegalArgumentException: if subCategory has an empty element name

getChildLogger

back to summary

public synchronized Logger getChildLogger(final String subCategory) throws IllegalArgumentException

Create a new child logger. The category of child logger is [current-category].subcategory

Parameters

subCategory:String: the subcategory of this logger

Returns:Logger

the new logger

Exceptions

IllegalArgumentException:: if subCategory has an empty element name

getChildren	back to summary
public synchronized Logger[] getChildren() Get all the child Loggers of current logger. Returns:Logger[] the child loggers

getChildren

back to summary

public synchronized Logger[] getChildren()

Get all the child Loggers of current logger.

Returns:Logger[]: the child loggers

info	back to summary
public final void info(final String message, final Throwable throwable) Log a info priority event. Parameters message:String the message throwable:Throwable the throwable

info

back to summary

public final void info(final String message, final Throwable throwable)

Log a info priority event.

Parameters

message:String: the message
throwable:Throwable: the throwable

info	back to summary
public final void info(final String message) Log a info priority event. Parameters message:String the message

info

back to summary

public final void info(final String message)

Log a info priority event.

Parameters

message:String: the message

isDebugEnabled	back to summary
public final boolean isDebugEnabled() Determine if messages of priority DEBUG will be logged. Returns:boolean true if DEBUG messages will be logged

isDebugEnabled

back to summary

public final boolean isDebugEnabled()

Determine if messages of priority DEBUG will be logged.

Returns:boolean: true if DEBUG messages will be logged

isErrorEnabled	back to summary
public final boolean isErrorEnabled() Determine if messages of priority ERROR will be logged. Returns:boolean true if ERROR messages will be logged

isErrorEnabled

back to summary

public final boolean isErrorEnabled()

Determine if messages of priority ERROR will be logged.

Returns:boolean: true if ERROR messages will be logged

isFatalErrorEnabled	back to summary
public final boolean isFatalErrorEnabled() Determine if messages of priority FATAL_ERROR will be logged. Returns:boolean true if FATAL_ERROR messages will be logged

isFatalErrorEnabled

back to summary

public final boolean isFatalErrorEnabled()

Determine if messages of priority FATAL_ERROR will be logged.

Returns:boolean: true if FATAL_ERROR messages will be logged

isInfoEnabled	back to summary
public final boolean isInfoEnabled() Determine if messages of priority INFO will be logged. Returns:boolean true if INFO messages will be logged

isInfoEnabled

back to summary

public final boolean isInfoEnabled()

Determine if messages of priority INFO will be logged.

Returns:boolean: true if INFO messages will be logged

isPriorityEnabled	back to summary
public final boolean isPriorityEnabled(final Priority priority) Determine if messages of priority �will be logged. Parameters priority:Priority the priority Returns:boolean true if messages will be logged

isPriorityEnabled

back to summary

public final boolean isPriorityEnabled(final Priority priority)

Determine if messages of priority �will be logged.

Parameters

priority:Priority: the priority

Returns:boolean

true if messages will be logged

isWarnEnabled	back to summary
public final boolean isWarnEnabled() Determine if messages of priority WARN will be logged. Returns:boolean true if WARN messages will be logged

isWarnEnabled

back to summary

public final boolean isWarnEnabled()

Determine if messages of priority WARN will be logged.

Returns:boolean: true if WARN messages will be logged

log	back to summary
public final void log(final Priority priority, final String message, final Throwable throwable) Log a event at specific priority with a certain message and throwable. Parameters priority:Priority the priority message:String the message throwable:Throwable the throwable

log

back to summary

public final void log(final Priority priority, final String message, final Throwable throwable)

Log a event at specific priority with a certain message and throwable.

Parameters

priority:Priority: the priority
message:String: the message
throwable:Throwable: the throwable

log	back to summary
public final void log(final Priority priority, final String message) Log a event at specific priority with a certain message. Parameters priority:Priority the priority message:String the message

log

back to summary

public final void log(final Priority priority, final String message)

Log a event at specific priority with a certain message.

Parameters

priority:Priority: the priority
message:String: the message

output	back to summary
private final void output(final Priority priority, final String message, final Throwable throwable) Internal method to do actual outputting. Parameters priority:Priority the priority message:String the message throwable:Throwable the throwable

output

back to summary

private final void output(final Priority priority, final String message, final Throwable throwable)

Internal method to do actual outputting.

Parameters

priority:Priority: the priority
message:String: the message
throwable:Throwable: the throwable

output	back to summary
private final void output(final LogEvent event)

resetChildLogTargets	back to summary
private synchronized void resetChildLogTargets(final boolean recursive) Update logTargets of children if any.

resetChildPriorities	back to summary
private synchronized void resetChildPriorities(final boolean recursive) Update priority of children if any.

resetLogTargets	back to summary
private synchronized void resetLogTargets(final 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	back to summary
private synchronized void resetPriority(final 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	back to summary
private synchronized LogTarget[] safeGetLogTargets() Retrieve logtarget array contained in logger. This method is provided so that child Loggers can access a copy of parents LogTargets. Returns:LogTarget[] the array of LogTargets

safeGetLogTargets

back to summary

private synchronized LogTarget[] safeGetLogTargets()

Retrieve logtarget array contained in logger. This method is provided so that child Loggers can access a copy of parents LogTargets.

Returns:LogTarget[]: the array of LogTargets

setAdditivity	back to summary
public final void setAdditivity(final 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:boolean true to make logger additive, false otherwise

setAdditivity

back to summary

public final void setAdditivity(final 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:boolean: true to make logger additive, false otherwise

setLogTargets	back to summary
public synchronized void setLogTargets(final LogTarget[] logTargets) Set the log targets for this logger. Parameters logTargets:LogTarget[] the Log Targets

setLogTargets

back to summary

public synchronized void setLogTargets(final LogTarget[] logTargets)

Set the log targets for this logger.

Parameters

logTargets:LogTarget[]: the Log Targets

setPriority	back to summary
public synchronized void setPriority(final Priority priority) Set the priority for this logger. Parameters priority:Priority the priority

setPriority

back to summary

public synchronized void setPriority(final Priority priority)

Set the priority for this logger.

Parameters

priority:Priority: the priority

setupErrorHandlers	back to summary
private synchronized void setupErrorHandlers() Set ErrorHandlers of LogTargets if necessary.

unsetLogTargets	back to summary
public synchronized 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	back to summary
public synchronized void unsetLogTargets(final 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:boolean the recursion policy

unsetLogTargets

back to summary

public synchronized void unsetLogTargets(final 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:boolean: the recursion policy

unsetPriority	back to summary
public synchronized void unsetPriority() Unset the priority of Logger. (Thus it will use it's parent's priority or DEBUG if no parent.

unsetPriority	back to summary
public synchronized void unsetPriority(final 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:boolean true to unset priority of all child loggers

unsetPriority

back to summary

public synchronized void unsetPriority(final 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:boolean: true to unset priority of all child loggers

warn

back to summary

public final void warn(final String message, final Throwable throwable)

Log a warn priority event.

Parameters

message:String: the message
throwable:Throwable: the throwable

warn

back to summary

public final void warn(final String message)

Log a warn priority event.

Parameters

message:String: the message

public Class Logger

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail