| java.lang.Object
 com.sun.midp.log.LoggingBase
All known Subclasses: com.sun.midp.log.Logging,
| LoggingBase | | public class LoggingBase (Code) | | The purpose of the logging service is to provide a standard means
to report runtime information from within Java or native code.
The porting process is eased by having to modify one logging
service implementation in place of handling the ad hoc use of
println(), printf(), putc(),
and other functions currently used.
An assert mechanism for Java code, implemented using the logging
service is also provided here for convenience.
This class consists of the Java interface to the functionality
of the logging service.
|
| Field Summary | |
| final public static int | CRITICAL
A reporting severity level. | | final public static int | CURRENT
Current reporting severity level. | | final public static int | DISABLED
A reporting severity level that should be used to disable all
reporting output and allow all bytecodes relating to the
report() method reporting to be compiled out of the build. | | final public static int | ERROR
A reporting severity level. | | final public static int | INFORMATION
A default reporting severity level. | | final public static int | WARNING
A reporting severity level. |
| Method Summary | |
| public static void | assertTrue(boolean condition, String message)
Report a message to the Logging service in the event that
condition is false. | | native public static void | report(int severity, int channelID, String message)
Report a message to the Logging service. | | public static void | trace(Throwable t, String message)
Obtain a stack trace from the Logging service, and report a message
to go along with it. |
| CRITICAL | | final public static int CRITICAL(Code) | | A reporting severity level. This level represents the most
severe error occurrence, indicating an unexpected condition which
is typically not recoverable or catastrophic to the system in some
way. Some action is required to correct the condition.
|
| CURRENT | | final public static int CURRENT(Code) | | Current reporting severity level. When used as an argument to
setReportLevel(), indicates that the current log level should
not be changed.
|
| DISABLED | | final public static int DISABLED(Code) | | A reporting severity level that should be used to disable all
reporting output and allow all bytecodes relating to the
report() method reporting to be compiled out of the build.
|
| ERROR | | final public static int ERROR(Code) | | A reporting severity level. This level represents an error
severity, indicating an unexpected condition which is typically
at least partially recoverable. Some action is expected to correct
the condition.
|
| INFORMATION | | final public static int INFORMATION(Code) | | A default reporting severity level. This level is the lowest
standard message reporting severity. It represents general
reporting information and is typically not associated with any
significant condition.
|
| WARNING | | final public static int WARNING(Code) | | A reporting severity level. This level represents a warning
severity, indicating an unexpected condition which is typically
fully recoverable. Some action may be appropriate to correct
the condition.
|
| assertTrue | | public static void assertTrue(boolean condition, String message)(Code) | | Report a message to the Logging service in the event that
condition is false. The message string should
include enough description that someone reading the message will
have enough context to find the failed assertion.
A use example:
if (Logging.ASSERT_ENABLED){
Logging.assertTrue([(boolean)conditional], "useful message");
}
This method reports nothing if message is null.
Parameters:
condition - asserted to be true by the caller.message is logged if false.
Parameters:
message - message to go with the report if the assert fails(when condition is false. |
| report | | native public static void report(int severity, int channelID, String message)(Code) | | Report a message to the Logging service. The message string should
include enough description that someone reading the message will
have enough context to diagnose and solve any problems if necessary.
The severity level should be one of:
- INFORMATION
- WARNING
- ERROR
- CRITICAL
and should properly reflect the severity of the message. The channel
identifier should be one of the pre defined channels listed in
the LogChannels.java file.
A use example:
if (Logging.REPORT_LEVEL <= severity) {
Logging.report(Logging.<severity>,
LogChannels.<channel>,
"[meaningful message]");
}
No output will occur if message is null.
Parameters:
severity - severity level of report
Parameters:
channelID - area report relates to, from LogChannels.java
Parameters:
message - message to go with the report |
| trace | | public static void trace(Throwable t, String message)(Code) | | Obtain a stack trace from the Logging service, and report a message
to go along with it. The message string should
include enough description that someone reading the message will
have enough context to diagnose and solve any problems if necessary.
A use example:
} catch (Throwable t) {
if (Logging.TRACE_ENABLED) {
Logging.trace(t, "[meaningful message]");
}
}
t
or message is null.
Parameters:
t - throwable causing this trace call
Parameters:
message - detail message for the trace log |
|
|