18.2.12 UserLogger interface
- Organization of this subsection
(1) Description
This interface is for user logs.
(2) Interface name
com.hitachi.software.xeads.common.UserLogger
(3) List of methods
The following table lists and describes the methods provided by the UserLogger interface:
|
Method name |
Description |
|---|---|
|
Outputs a message ID and a message text. |
|
|
Outputs only a message text. |
|
|
Outputs a message ID and a stack trace. |
|
|
Outputs only a stack trace. |
(4) log() (format 1)
(a) Description
This method outputs a message ID and a message text.
(b) Format
public void log(java.lang.String messageID,
java.lang.String message)(c) Parameters
- messageID
-
Specifies a message ID.
A maximum of 21 single-byte characters can be specified.
Do not specify double-byte characters or control characters, because these characters might corrupt the format.
If null is specified, the null character string is output.
- message
-
Specifies a message text.
Do not specify control characters, because they might corrupt the format.
If null is specified, the null character string is output.
(5) log() (format 2)
(a) Description
This method outputs only a message text. The method outputs the null character string for the message ID.
(b) Format
public void log(java.lang.String message)
(c) Parameters
- message
-
Specifies a message text.
Do not specify control characters, because they might corrupt the format.
If null is specified, the null character string is output.
(6) putStackTrace() (format 1)
(a) Description
This method outputs a message ID and a stack trace.
The method outputs a detailed message and cause of a specified exception.
(b) Format
public void putStackTrace(java.lang.String messageID,
Throwable cause)(c) Parameters
- messageID
-
Specifies a message ID.
A maximum of 21 single-byte characters can be specified.
Do not specify double-byte characters or control characters, because these characters might corrupt the format.
If null is specified, the null character string is output.
- cause
-
Specifies an exception object.
If null is specified, the null character string is output.
(7) putStackTrace() (format 2)
(a) Description
This method outputs only a stack trace. The method outputs the null character string for a message ID.
The method outputs a detailed message and cause of a specified exception.
(b) Format
public void putStackTrace(Throwable cause)
(c) Parameters
- cause
-
Specifies an exception object.
If null is specified, the null character string is output.