|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Log
A simple logging interface that is used by the Ephox-namespaced Apache Commons logging API.
The six 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 is done by EditLive!, and can be controlled using LoggingUtils
.
Method Summary | |
---|---|
void |
debug(Object message)
Log a message with debug log level. |
void |
debug(Object message,
Throwable t)
Log an error with debug log level. |
void |
error(Object message)
Log a message with error log level. |
void |
error(Object message,
Throwable t)
Log an error with error log level. |
void |
errorIfObjectIsNull(Object obj,
Object message)
Logs the message using error(Object) only if obj is null |
void |
fatal(Object message)
Log a message with fatal log level. |
void |
fatal(Object message,
Throwable t)
Log an error with fatal log level. |
void |
info(Object message)
Log a message with info log level. |
void |
info(Object message,
Throwable t)
Log an error with info log level. |
boolean |
isDebugEnabled()
Is debug logging currently enabled? |
boolean |
isErrorEnabled()
Is error logging currently enabled? |
boolean |
isFatalEnabled()
Is fatal logging currently enabled? |
boolean |
isInfoEnabled()
Is info logging currently enabled? |
boolean |
isTraceEnabled()
Is trace logging currently enabled? |
boolean |
isWarnEnabled()
Is warning logging currently enabled? |
void |
trace(Object message)
Log a message with trace log level. |
void |
trace(Object message,
Throwable t)
Log an error with trace log level. |
void |
warn(Object message)
Log a message with warn log level. |
void |
warn(Object message,
Throwable t)
Log an error with warn log level. |
Method Detail |
---|
boolean isDebugEnabled()
Is debug logging currently enabled?
Call this method to prevent having to perform expensive operations (for example, String
concatenation) when the log level is more than debug.
boolean isErrorEnabled()
Is error logging currently enabled?
Call this method to prevent having to perform expensive operations (for example, String
concatenation) when the log level is more than error.
boolean isFatalEnabled()
Is fatal logging currently enabled?
Call this method to prevent having to perform expensive operations (for example, String
concatenation) when the log level is more than fatal.
boolean isInfoEnabled()
Is info logging currently enabled?
Call this method to prevent having to perform expensive operations (for example, String
concatenation) when the log level is more than info.
boolean isTraceEnabled()
Is trace logging currently enabled?
Call this method to prevent having to perform expensive operations (for example, String
concatenation) when the log level is more than trace.
boolean isWarnEnabled()
Is warning logging currently enabled?
Call this method to prevent having to perform expensive operations (for example, String
concatenation) when the log level is more than warning.
void trace(Object message)
Log a message with trace log level.
message
- log this messagevoid trace(Object message, Throwable t)
Log an error with trace log level.
message
- log this messaget
- log this causevoid debug(Object message)
Log a message with debug log level.
message
- log this messagevoid debug(Object message, Throwable t)
Log an error with debug log level.
message
- log this messaget
- log this causevoid info(Object message)
Log a message with info log level.
message
- log this messagevoid info(Object message, Throwable t)
Log an error with info log level.
message
- log this messaget
- log this causevoid warn(Object message)
Log a message with warn log level.
message
- log this messagevoid warn(Object message, Throwable t)
Log an error with warn log level.
message
- log this messaget
- log this causevoid error(Object message)
Log a message with error log level.
message
- log this messagevoid error(Object message, Throwable t)
Log an error with error log level.
message
- log this messaget
- log this causevoid errorIfObjectIsNull(Object obj, Object message)
error(Object)
only if obj is null
void fatal(Object message)
Log a message with fatal log level.
message
- log this messagevoid fatal(Object message, Throwable t)
Log an error with fatal log level.
message
- log this messaget
- log this cause
|
Copyright (c) 2005-2012 Ephox Pty Ltd. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |