Constructor
new DOMAppender(level, category, DOMObj)
Constructor for DOMAppender.
Parameters:
| Name | Type | Description |
|---|---|---|
level |
String |
The threshold level at which the SimpleLogAppender is created. It should be one of "DEBUG", "INFO", "WARN", "ERROR" and "FATAL". If not or wrongly specified INFO is assumed. |
category |
String |
The category this appender should listen to. If not specified the appender will get log for every available category. See SimpleLogAppender#setCategoryFilter. |
DOMObj |
Object |
The DOM object to use for log message publishing. |
Throws:
-
if the DOMElement parameter is missing.
Extends
Methods
(protected) composeLine(category, level, mex, header) → {String}
Utility method that can be used by subclasses to join various info in a single line. The message will be composed this way: category + " | " + level + " | " + header + " | " + mex
Parameters:
| Name | Type | Description |
|---|---|---|
category |
String |
the message category |
level |
String |
the message level |
mex |
String |
the message itself |
header |
String |
a custom header |
- Inherited From:
Returns:
- Type
- String
getCategoryFilter() → {String}
Inquiry method that returns the category for this SimpleLogAppender instance. A SimpleLogAppender only receives log lines from the Logger associated to the returned category, unless "*" is returned, in which case it receives log from all loggers.
- Inherited From:
Returns:
The category of this SimpleLogAppender instance, or "*".
- Type
- String
getLevel() → {String}
Inquiry method that returns the current threshold level of this SimpleLogAppender instance.
- Inherited From:
Returns:
the level of this SimpleLogAppender instance. It will be one of "DEBUG", "INFO", "WARN", "ERROR" and "FATAL".
- Type
- String
log(category, level, mex, header)
Publish a log message on the specified DOM object.
Parameters:
| Name | Type | Description |
|---|---|---|
category |
String |
the logger category that produced the given message. |
level |
String |
the logging level of the given message. It should be one of DEBUG INFO WARN ERROR FATAL. |
mex |
String |
the message to be logged. It could be a String instance, an Error instance or any other object, provided that it has a toString method. |
header |
String |
a header for the message |
- Overrides:
setCategoryFilter(categoryopt)
Setter method that changes the current category of this
SimpleLogAppender instance.
This SimpleLogAppender will only receive log lines from the Logger
associated to the specified category, unless
"*" is specified, in which case it will receive log from all loggers.
the filter can be changed at any time and will affect subsequent log lines.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
category |
String |
<optional> |
the new category for this SimpleLogAppender, or "". If not specified "" is assumed |
- Inherited From:
setLevel(levelopt)
Setter method that changes the current threshold level of this SimpleLogAppender instance. The filter can be changed at any time and will affect subsequent log lines
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
level |
String |
<optional> |
The new level for this SimpleLogAppender instance. It should be one of "DEBUG", "INFO", "WARN", "ERROR" and "FATAL". If not or wrongly specified INFO will be used. |
- Inherited From:
setLoggerProvider(loggerProvider)
Called by SimpleLoggerProvider to notify itself to a newly added appender.
Parameters:
| Name | Type | Description |
|---|---|---|
loggerProvider |
SimpleLoggerProvider |
the SimpleLoggerProvider instance handling this appender. |
- Inherited From:
setNextOnTop(nextOnTopopt)
Setter method that specifies if new log messages have to be shown on top of the previous ones.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
nextOnTop |
boolean |
<optional> |
Layout of log messages in the DOM object; if true the newest log line is displayed on top of DOM object. false by default. |
setUseInnerHtml(useInnerHtml)
Setter method that specifies how new log lines have to be included
in the given container DOM object. In fact, some log lines may contain
custom parts (for instance, field values) that may be expressed in HTML
and intended for HTML rendering. In this case, instead of putting the
log messages in text nodes, the appender can be set for directly adding messages to the
innerHTML of the container object.
WARNING: When turning HTML interpretation on, make sure that
no malicious code may reach the log.
Parameters:
| Name | Type | Description |
|---|---|---|
useInnerHtml |
boolean |
Flag to switch On/Off the use of innerHTML. false by default. |