oracle.hsgbu.hdr.logging.common

Interface Log

All Known Implementing Classes:

JDKLoggerWrapper, Log4JLoggerWrapper

public interface Log

A simple logging interface abstracting logging APIs

Method Summary

Modifier and Type	Method and Description
void	debug(Object message) Logs a message with debug log level.
void	debug(Object message, Throwable t) Logs a message with debug log level.
void	debug(Supplier<?> msgSupplier) Logs a message which is only to be constructed if the logging level is debug level
void	debug(Supplier<?> msgSupplier, Throwable t) Logs a message (only to be constructed if the logging level is the debug level) including the stack trace of the Throwable t passed as parameter.
void	error(Object message) Logs a message with error log level.
void	error(Object message, Throwable t) Logs an error with error log level.
void	error(Supplier<?> msgSupplier) Logs a message which is only to be constructed if the logging level is error level
void	error(Supplier<?> msgSupplier, Throwable t) Logs a message (only to be constructed if the logging level is the error level) including the stack trace of the Throwable t passed as parameter.
void	fatal(Object message) Logs a message with fatal log level.
void	fatal(Object message, Throwable t) Logs an error with fatal log level.
String	getName() Get the name for this logger.
void	info(Object message) Logs a message with info log level.
void	info(Object message, Throwable t) Logs an error with info log level.
void	info(Supplier<?> msgSupplier) Logs a message which is only to be constructed if the logging level is the info level.
void	info(Supplier<?> msgSupplier, Throwable t) Logs a message (only to be constructed if the logging level is the info level) including the stack trace of the Throwable t passed as parameter.
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 warn logging currently enabled?
void	trace(Object message) Logs a message with trace log level.
void	trace(Object message, Throwable t) Logs an error with trace log level.
void	warn(Object message) Logs a message with warn log level.
void	warn(Object message, Throwable t) Logs an error with warn log level.
void	warn(Supplier<?> msgSupplier) Logs a message which is only to be constructed if the logging level is the warn level.
void	warn(Supplier<?> msgSupplier, Throwable t) Logs a message (only to be constructed if the logging level is the warn level) including the stack trace of the Throwable t passed as parameter.

Method Detail

debug

void debug(Object message)

Logs a message with debug log level.

Parameters:

message - log this message

debug

void debug(Object message,
           Throwable t)

Logs a message with debug log level.

Parameters:

message - log this message

t - log this cause

debug

void debug(Supplier<?> msgSupplier)

Logs a message which is only to be constructed if the logging level is debug level

Parameters:

msgSupplier - A function, which when called, produces the desired log message

debug

void debug(Supplier<?> msgSupplier,
           Throwable t)

Logs a message (only to be constructed if the logging level is the debug level) including the stack trace of the Throwable t passed as parameter.

Parameters:

msgSupplier - A function, which when called, produces the desired log message

t - the exception to log, including its stack trace.

error

void error(Object message)

Logs a message with error log level.

Parameters:

message - log this message

error

void error(Object message,
           Throwable t)

Logs an error with error log level.

Parameters:

message - log this message

t - log this cause

error

void error(Supplier<?> msgSupplier)

Logs a message which is only to be constructed if the logging level is error level

Parameters:

msgSupplier - A function, which when called, produces the desired log message

error

void error(Supplier<?> msgSupplier,
           Throwable t)

Logs a message (only to be constructed if the logging level is the error level) including the stack trace of the Throwable t passed as parameter.

Parameters:

msgSupplier - A function, which when called, produces the desired log message

t - the exception to log, including its stack trace.

fatal

void fatal(Object message)

Logs a message with fatal log level.

Parameters:

message - log this message

fatal

void fatal(Object message,
           Throwable t)

Logs an error with fatal log level.

Parameters:

message - log this message

t - log this cause

info

void info(Object message)

Logs a message with info log level.

Parameters:

message - log this message

info

void info(Object message,
          Throwable t)

Logs an error with info log level.

Parameters:

message - log this message

t - log this cause

info

void info(Supplier<?> msgSupplier)

Logs a message which is only to be constructed if the logging level is the info level.

Parameters:

msgSupplier - A function, which when called, produces the desired log message

info

void info(Supplier<?> msgSupplier,
          Throwable t)

Logs a message (only to be constructed if the logging level is the info level) including the stack trace of the Throwable t passed as parameter.

Parameters:

msgSupplier - A function, which when called, produces the desired log message

t - the exception to log, including its stack trace.

isDebugEnabled

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.

Returns:

true if debug is enabled in the underlying logger.

isErrorEnabled

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.

Returns:

true if error is enabled in the underlying logger.

isFatalEnabled

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.

Returns:

true if fatal is enabled in the underlying logger.

isInfoEnabled

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.

Returns:

true if info is enabled in the underlying logger.

isTraceEnabled

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.

Returns:

true if trace is enabled in the underlying logger.

isWarnEnabled

boolean isWarnEnabled()

Is warn logging currently enabled?

Call this method to prevent having to perform expensive operations (for example, String concatenation) when the log level is more than warn.

Returns:

true if warn is enabled in the underlying logger.

trace

void trace(Object message)

Logs a message with trace log level.

Parameters:

message - log this message

trace

void trace(Object message,
           Throwable t)

Logs an error with trace log level.

Parameters:

message - log this message

t - log this cause

warn

void warn(Object message)

Logs a message with warn log level.

Parameters:

message - log this message

warn

void warn(Object message,
          Throwable t)

Logs an error with warn log level.

Parameters:

message - log this message

t - log this cause

warn

void warn(Supplier<?> msgSupplier)

Logs a message which is only to be constructed if the logging level is the warn level.

Parameters:

msgSupplier - A function, which when called, produces the desired log message

warn

void warn(Supplier<?> msgSupplier,
          Throwable t)

Logs a message (only to be constructed if the logging level is the warn level) including the stack trace of the Throwable t passed as parameter.

Parameters:

msgSupplier - A function, which when called, produces the desired log message

t - the exception to log, including its stack trace.

getName

String getName()

Get the name for this logger.

Returns:

logger name.