|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface LogNoi18n
Non-internationalised logging interface abstracting the various logging APIs
supported by Arjuna CLF.
See Logi18n
for an internationalised version and for more
information.
The five logging levels used by Log
are (in order):
Performance is often a logging concern. By examining the appropriate property, a component can avoid expensive operations (producing information to be logged).
For example,
if (log.isDebugEnabled()) {
... do something expensive ...
log.debug(theResult);
}
Configuration of the underlying logging system will generally be done external to the Logging APIs, through whatever mechanism is supported by that system.
Method Summary | |
---|---|
void |
debug(long dl,
long vl,
long fl,
java.lang.Object message)
Deprecated. |
void |
debug(long dl,
long vl,
long fl,
java.lang.String message)
Log a message with the DEBUG Level and with finer granularity. |
void |
debug(java.lang.Object message)
Log a message with DEBUG Level |
void |
debug(java.lang.String message)
Log a message with DEBUG Level |
boolean |
debugAllowed()
Is it allowed to print finer debugging statements? This method returns true when the following is set: finer debug level = DebugLevel.FULL_DEBUGGING .
visibility level = VisibilityLevel.VIS_ALL .
facility code = FacilityCode.FAC_ALL .
|
boolean |
debugAllowed(long dLevel)
Is it allowed to print finer debugging statements with a given debug level? This method assumes that: visibility level = VisibilityLevel.VIS_ALL .
facility code = FacilityCode.FAC_ALL .
|
boolean |
debugAllowed(long dLevel,
long vLevel)
Is it allowed to print debugging statements? This method assumes |
boolean |
debugAllowed(long dLevel,
long vLevel,
long fLevel)
Is it allowed to print finer debugging statements with a given debug level, visibility level and facility code level? |
void |
error(java.lang.Object message)
Log a message with ERROR Level |
void |
error(java.lang.String message)
Log a message with ERROR Level |
void |
fatal(java.lang.Object message)
Log a message with FATAL Level |
void |
fatal(java.lang.String message)
Log a message with FATAL Level |
long |
getDebugLevel()
Return the finer debug level. |
long |
getFacilityCode()
Return the facility code. |
long |
getVisibilityLevel()
Return the visibility level. |
void |
info(java.lang.Object message)
Log a message with INFO Level |
void |
info(java.lang.String message)
Log a message with INFO Level |
boolean |
isDebugEnabled()
Determine if this logger is enabled for DEBUG messages. |
boolean |
isErrorEnabled()
Determine if this logger is enabled for ERROR messages. |
boolean |
isFatalEnabled()
Determine if this logger is enabled for FATAL messages. |
boolean |
isInfoEnabled()
Determine if this logger is enabled for INFO messages. |
boolean |
isWarnEnabled()
Determine if this logger is enabled for WARN messages. |
void |
mergeDebugLevel(long level)
Merge the debug level provided with that currently used by the controller. |
void |
mergeFacilityCode(long level)
Merge the debug level provided with that currently used by the Logger. |
void |
mergeVisibilityLevel(long level)
Merge the visibility level provided with that currently used by the Logger. |
void |
setDebugLevel(long level)
Set the debug level as available in the DebugLevel . |
void |
setFacilityCode(long level)
Set the facility code. |
void |
setLevels(long dl,
long vl,
long fl)
Set the debug level, the visibility level, and the facility code. |
void |
setVisibilityLevel(long level)
Set the visibility level. |
void |
warn(java.lang.Object message)
Log a message with WARN Level |
void |
warn(java.lang.String message)
Log a message with WARN Level |
Method Detail |
---|
boolean isDebugEnabled()
boolean isInfoEnabled()
boolean isWarnEnabled()
boolean isErrorEnabled()
boolean isFatalEnabled()
void debug(java.lang.Object message)
message
- the message to logvoid debug(java.lang.String message)
message
- the message to logvoid info(java.lang.Object message)
message
- the message to logvoid info(java.lang.String message)
message
- the message to logvoid warn(java.lang.Object message)
message
- the message to logvoid warn(java.lang.String message)
message
- the message to logvoid error(java.lang.Object message)
message
- the message to logvoid error(java.lang.String message)
message
- the message to logvoid fatal(java.lang.Object message)
message
- the message to logvoid fatal(java.lang.String message)
message
- the message to logvoid debug(long dl, long vl, long fl, java.lang.Object message)
Note: this method does not use i18n. ie, message is directly used for log output.
dl
- The debug finer level associated with the log message. That is, the logger object allows
to log only if the DEBUG level is allowed and dl is either equals or greater the debug level assigned to
the logger Objectvl
- The visibility level associated with the log message. That is, the logger object allows
to log only if the DEBUG level is allowed and vl is either equals or greater the visibility level assigned to
the logger Objectfl
- The facility code level associated with the log message. That is, the logger object allows
to log only if the DEBUG level is allowed and fl is either equals or greater the facility code level assigned to
the logger Objectmessage
- The message to log.void debug(long dl, long vl, long fl, java.lang.String message)
Note: this method does not use i18n. ie, message is directly used for log output.
dl
- The debug finer level associated with the log message. That is, the logger object allows
to log only if the DEBUG level is allowed and dl is either equals or greater the debug level assigned to
the logger Objectvl
- The visibility level associated with the log message. That is, the logger object allows
to log only if the DEBUG level is allowed and vl is either equals or greater the visibility level assigned to
the logger Objectfl
- The facility code level associated with the log message. That is, the logger object allows
to log only if the DEBUG level is allowed and fl is either equals or greater the facility code level assigned to
the logger Objectmessage
- The message to log.void setLevels(long dl, long vl, long fl)
dl
- The finer debugging value.
See DebugLevel
for possible values.vl
- The visibility level value.
See VisibilityLevel
for possible values.fl
- The facility code level value.
See FacilityCode
for possible values.long getDebugLevel()
for possible return values.
void setDebugLevel(long level)
DebugLevel
.
level
- The finer debugging valuefor possible values of level
.
void mergeDebugLevel(long level)
level
- The finer debugging valuefor possible values of level
.
long getVisibilityLevel()
for possible return values.
void setVisibilityLevel(long level)
level
- The visibility level valuefor possible values of level
.
void mergeVisibilityLevel(long level)
level
- The visibility level valuefor possible values of level
.
long getFacilityCode()
for possible return values.
void setFacilityCode(long level)
level
- The facility code valuefor possible values of level
.
void mergeFacilityCode(long level)
level
- The visibility level valuefor possible values of level
.
boolean debugAllowed()
DebugLevel.FULL_DEBUGGING
.VisibilityLevel.VIS_ALL
.FacilityCode.FAC_ALL
.
boolean debugAllowed(long dLevel)
VisibilityLevel.VIS_ALL
.FacilityCode.FAC_ALL
.
dLevel
- The debug finer level to check for.
dLevel
.
i.e., dLevel is either equals or greater than the finer debug level assigned to the Logger.boolean debugAllowed(long dLevel, long vLevel)
FacilityCode.FAC_ALL)
dLevel
- The debug finer level. Used to ask if the logger object allows logging for this value.
The answer is yes if dLevel is either equals or greater the debug level assigned to the loggervLevel
- The visibility level. Used to ask if the logger object allows logging for this value.
The answer is yes if vLevel is either equals or greater the visibility level assigned to the logger
boolean debugAllowed(long dLevel, long vLevel, long fLevel)
dLevel
- The debug finer level to check for.vLevel
- The debug visibilty level to check for.fLevel
- The facility code level to check for.
dLevel
,
visibility level vLevel
and facility code level fLevel
.
i.e., dLevel is equal or greater than the finer debug level assigned to the Logger
and vLevel is equal or greater than the visiblity level
and fLevel is equal or greater then the facility code level.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |