oracle.cabo.share.error
Interface ErrorLog

All Known Implementing Classes:

BaseErrorLog, CompositeErrorLog, RecordingErrorLog

public interface ErrorLog

Interface for error logging. An instance of this interface is attached to a RenderingContext, and is used to both display errors as they occur (e.g., send the messages to a servlet log), and store the errors so multiple errors can be retrieved later.

Field Summary

static int	VERBOSITY_DEBUG Verbosity level indicating a debug message.
static int	VERBOSITY_ERROR Verbosity level indicating an error.
static int	VERBOSITY_INFO Verbosity level indicating an informational message.
static int	VERBOSITY_NONE Verbosity level indicating a message that should never be logged.
static int	VERBOSITY_WARNING Verbosity level indicating a warning.

Method Summary

java.lang.Throwable[]	getLoggedErrors() Returns an array of all logged errors.
boolean	isErrorPresent() Returns true if any errors have been logged.
void	log(java.lang.String message, java.lang.Throwable t, int level) Records a message and error on the log with a specific verbosity level.
void	logError(java.lang.Throwable t) Records a Throwable, and sends it to the log.
void	logMessage(java.lang.String s) Sends a string message to the log.
boolean	matchesVerbosity(int level) Returns true if the given verbosity level would result in a message being logged.

Field Detail

VERBOSITY_ERROR

public static final int VERBOSITY_ERROR

Verbosity level indicating an error.

VERBOSITY_WARNING

public static final int VERBOSITY_WARNING

Verbosity level indicating a warning.

VERBOSITY_INFO

public static final int VERBOSITY_INFO

Verbosity level indicating an informational message.

VERBOSITY_DEBUG

public static final int VERBOSITY_DEBUG

Verbosity level indicating a debug message.

VERBOSITY_NONE

public static final int VERBOSITY_NONE

Verbosity level indicating a message that should never be logged.

Method Detail

isErrorPresent

public boolean isErrorPresent()

Returns true if any errors have been logged.

getLoggedErrors

public java.lang.Throwable[] getLoggedErrors()

Returns an array of all logged errors. Returns null if no errors have been logged.

logMessage

public void logMessage(java.lang.String s)

Sends a string message to the log.

logError

public void logError(java.lang.Throwable t)

Records a Throwable, and sends it to the log.

log

public void log(java.lang.String message,
                java.lang.Throwable t,
                int level)

Records a message and error on the log with a specific verbosity level.

matchesVerbosity

public boolean matchesVerbosity(int level)

Returns true if the given verbosity level would result in a message being logged. Clients can check this before calling log if the log information would be expensive to create.