com.couchbase.client.core.logging

Interface CouchbaseLogger

All Known Implementing Classes:

AbstractCouchbaseLogger

public interface CouchbaseLogger

Internal-use-only logger used by the SDK. DO NOT access this class outside of the SDK.

Method Summary

Modifier and Type	Method and Description
void	debug(String msg) Log a message at the DEBUG level.
void	debug(String format, Object... arguments) Log a message at the DEBUG level according to the specified format and arguments.
void	debug(String format, Object arg) Log a message at the DEBUG level according to the specified format and argument.
void	debug(String format, Object argA, Object argB) Log a message at the DEBUG level according to the specified format and arguments.
void	debug(String msg, Throwable t) Log an exception (throwable) at the DEBUG level with an accompanying message.
void	debug(Throwable t) Log an exception (throwable) at the DEBUG level.
void	error(String msg) Log a message at the ERROR level.
void	error(String format, Object... arguments) Log a message at the ERROR level according to the specified format and arguments.
void	error(String format, Object arg) Log a message at the ERROR level according to the specified format and argument.
void	error(String format, Object argA, Object argB) Log a message at the ERROR level according to the specified format and arguments.
void	error(String msg, Throwable t) Log an exception (throwable) at the ERROR level with an accompanying message.
void	error(Throwable t) Log an exception (throwable) at the ERROR level.
void	info(String msg) Log a message at the INFO level.
void	info(String format, Object... arguments) Log a message at the INFO level according to the specified format and arguments.
void	info(String format, Object arg) Log a message at the INFO level according to the specified format and argument.
void	info(String format, Object argA, Object argB) Log a message at the INFO level according to the specified format and arguments.
void	info(String msg, Throwable t) Log an exception (throwable) at the INFO level with an accompanying message.
void	info(Throwable t) Log an exception (throwable) at the INFO level.
boolean	isDebugEnabled() Is the logger instance enabled for the DEBUG level?
boolean	isEnabled(CouchbaseLogLevel level) Is the logger instance enabled for the specified level?
boolean	isErrorEnabled() Is the logger instance enabled for the ERROR level?
boolean	isInfoEnabled() Is the logger instance enabled for the INFO level?
boolean	isTraceEnabled() Is the logger instance enabled for the TRACE level?
boolean	isWarnEnabled() Is the logger instance enabled for the WARN level?
void	log(CouchbaseLogLevel level, String msg) Log a message at the specified level.
void	log(CouchbaseLogLevel level, String format, Object... arguments) Log a message at the specified level according to the specified format and arguments.
void	log(CouchbaseLogLevel level, String format, Object arg) Log a message at the specified level according to the specified format and argument.
void	log(CouchbaseLogLevel level, String format, Object argA, Object argB) Log a message at the specified level according to the specified format and arguments.
void	log(CouchbaseLogLevel level, String msg, Throwable t) Log an exception (throwable) at the specified level with an accompanying message.
void	log(CouchbaseLogLevel level, Throwable t) Log an exception (throwable) at the specified level.
String	name() Return the name of this CouchbaseLogger instance.
void	trace(String msg) Log a message at the TRACE level.
void	trace(String format, Object... arguments) Log a message at the TRACE level according to the specified format and arguments.
void	trace(String format, Object arg) Log a message at the TRACE level according to the specified format and argument.
void	trace(String format, Object argA, Object argB) Log a message at the TRACE level according to the specified format and arguments.
void	trace(String msg, Throwable t) Log an exception (throwable) at the TRACE level with an accompanying message.
void	trace(Throwable t) Log an exception (throwable) at the TRACE level.
void	warn(String msg) Log a message at the WARN level.
void	warn(String format, Object... arguments) Log a message at the WARN level according to the specified format and arguments.
void	warn(String format, Object arg) Log a message at the WARN level according to the specified format and argument.
void	warn(String format, Object argA, Object argB) Log a message at the WARN level according to the specified format and arguments.
void	warn(String msg, Throwable t) Log an exception (throwable) at the WARN level with an accompanying message.
void	warn(Throwable t) Log an exception (throwable) at the WARN level.

Method Detail

name

String name()

Return the name of this CouchbaseLogger instance.

Returns:

name of this logger instance

isTraceEnabled

boolean isTraceEnabled()

Is the logger instance enabled for the TRACE level?

Returns:

True if this Logger is enabled for the TRACE level, false otherwise.

trace

void trace(String msg)

Log a message at the TRACE level.

Parameters:

msg - the message string to be logged

trace

void trace(String format,
           Object arg)

Log a message at the TRACE level according to the specified format and argument.

This form avoids superfluous object creation when the logger is disabled for the TRACE level.

Parameters:

format - the format string

arg - the argument

trace

void trace(String format,
           Object argA,
           Object argB)

Log a message at the TRACE level according to the specified format and arguments.

This form avoids superfluous object creation when the logger is disabled for the TRACE level.

Parameters:

format - the format string

argA - the first argument

argB - the second argument

trace

void trace(String format,
           Object... arguments)

Log a message at the TRACE level according to the specified format and arguments.

This form avoids superfluous string concatenation when the logger is disabled for the TRACE level. However, this variant incurs the hidden (and relatively small) cost of creating an Object[] before invoking the method, even if this logger is disabled for TRACE. The variants taking one and two arguments exist solely in order to avoid this hidden cost.

Parameters:

format - the format string

arguments - a list of 3 or more arguments

trace

void trace(String msg,
           Throwable t)

Log an exception (throwable) at the TRACE level with an accompanying message.

Parameters:

msg - the message accompanying the exception

t - the exception (throwable) to log

trace

void trace(Throwable t)

Log an exception (throwable) at the TRACE level.

Parameters:

t - the exception (throwable) to log

isDebugEnabled

boolean isDebugEnabled()

Is the logger instance enabled for the DEBUG level?

Returns:

True if this Logger is enabled for the DEBUG level, false otherwise.

debug

void debug(String msg)

Log a message at the DEBUG level.

Parameters:

msg - the message string to be logged

debug

void debug(String format,
           Object arg)

Log a message at the DEBUG level according to the specified format and argument.

This form avoids superfluous object creation when the logger is disabled for the DEBUG level.

Parameters:

format - the format string

arg - the argument

debug

void debug(String format,
           Object argA,
           Object argB)

Log a message at the DEBUG level according to the specified format and arguments.

This form avoids superfluous object creation when the logger is disabled for the DEBUG level.

Parameters:

format - the format string

argA - the first argument

argB - the second argument

debug

void debug(String format,
           Object... arguments)

Log a message at the DEBUG level according to the specified format and arguments.

This form avoids superfluous string concatenation when the logger is disabled for the DEBUG level. However, this variant incurs the hidden (and relatively small) cost of creating an Object[] before invoking the method, even if this logger is disabled for DEBUG. The variants taking one and two arguments exist solely in order to avoid this hidden cost.

Parameters:

format - the format string

arguments - a list of 3 or more arguments

debug

void debug(String msg,
           Throwable t)

Log an exception (throwable) at the DEBUG level with an accompanying message.

Parameters:

msg - the message accompanying the exception

t - the exception (throwable) to log

debug

void debug(Throwable t)

Log an exception (throwable) at the DEBUG level.

Parameters:

t - the exception (throwable) to log

isInfoEnabled

boolean isInfoEnabled()

Is the logger instance enabled for the INFO level?

Returns:

True if this Logger is enabled for the INFO level, false otherwise.

info

void info(String msg)

Log a message at the INFO level.

Parameters:

msg - the message string to be logged

info

void info(String format,
          Object arg)

Log a message at the INFO level according to the specified format and argument.

This form avoids superfluous object creation when the logger is disabled for the INFO level.

Parameters:

format - the format string

arg - the argument

info

void info(String format,
          Object argA,
          Object argB)

Log a message at the INFO level according to the specified format and arguments.

This form avoids superfluous object creation when the logger is disabled for the INFO level.

Parameters:

format - the format string

argA - the first argument

argB - the second argument

info

void info(String format,
          Object... arguments)

Log a message at the INFO level according to the specified format and arguments.

This form avoids superfluous string concatenation when the logger is disabled for the INFO level. However, this variant incurs the hidden (and relatively small) cost of creating an Object[] before invoking the method, even if this logger is disabled for INFO. The variants taking one and two arguments exist solely in order to avoid this hidden cost.

Parameters:

format - the format string

arguments - a list of 3 or more arguments

info

void info(String msg,
          Throwable t)

Log an exception (throwable) at the INFO level with an accompanying message.

Parameters:

msg - the message accompanying the exception

t - the exception (throwable) to log

info

void info(Throwable t)

Log an exception (throwable) at the INFO level.

Parameters:

t - the exception (throwable) to log

isWarnEnabled

boolean isWarnEnabled()

Is the logger instance enabled for the WARN level?

Returns:

True if this Logger is enabled for the WARN level, false otherwise.

warn

void warn(String msg)

Log a message at the WARN level.

Parameters:

msg - the message string to be logged

warn

void warn(String format,
          Object arg)

Log a message at the WARN level according to the specified format and argument.

This form avoids superfluous object creation when the logger is disabled for the WARN level.

Parameters:

format - the format string

arg - the argument

warn

void warn(String format,
          Object... arguments)

Log a message at the WARN level according to the specified format and arguments.

This form avoids superfluous string concatenation when the logger is disabled for the WARN level. However, this variant incurs the hidden (and relatively small) cost of creating an Object[] before invoking the method, even if this logger is disabled for WARN. The variants taking one and two arguments exist solely in order to avoid this hidden cost.

Parameters:

format - the format string

arguments - a list of 3 or more arguments

warn

void warn(String format,
          Object argA,
          Object argB)

Log a message at the WARN level according to the specified format and arguments.

This form avoids superfluous object creation when the logger is disabled for the WARN level.

Parameters:

format - the format string

argA - the first argument

argB - the second argument

warn

void warn(String msg,
          Throwable t)

Log an exception (throwable) at the WARN level with an accompanying message.

Parameters:

msg - the message accompanying the exception

t - the exception (throwable) to log

warn

void warn(Throwable t)

Log an exception (throwable) at the WARN level.

Parameters:

t - the exception (throwable) to log

isErrorEnabled

boolean isErrorEnabled()

Is the logger instance enabled for the ERROR level?

Returns:

True if this Logger is enabled for the ERROR level, false otherwise.

error

void error(String msg)

Log a message at the ERROR level.

Parameters:

msg - the message string to be logged

error

void error(String format,
           Object arg)

Log a message at the ERROR level according to the specified format and argument.

This form avoids superfluous object creation when the logger is disabled for the ERROR level.

Parameters:

format - the format string

arg - the argument

error

void error(String format,
           Object argA,
           Object argB)

Log a message at the ERROR level according to the specified format and arguments.

This form avoids superfluous object creation when the logger is disabled for the ERROR level.

Parameters:

format - the format string

argA - the first argument

argB - the second argument

error

void error(String format,
           Object... arguments)

Log a message at the ERROR level according to the specified format and arguments.

This form avoids superfluous string concatenation when the logger is disabled for the ERROR level. However, this variant incurs the hidden (and relatively small) cost of creating an Object[] before invoking the method, even if this logger is disabled for ERROR. The variants taking one and two arguments exist solely in order to avoid this hidden cost.

Parameters:

format - the format string

arguments - a list of 3 or more arguments

error

void error(String msg,
           Throwable t)

Log an exception (throwable) at the ERROR level with an accompanying message.

Parameters:

msg - the message accompanying the exception

t - the exception (throwable) to log

error

void error(Throwable t)

Log an exception (throwable) at the ERROR level.

Parameters:

t - the exception (throwable) to log

isEnabled

boolean isEnabled(CouchbaseLogLevel level)

Is the logger instance enabled for the specified level?

Returns:

True if this Logger is enabled for the specified level, false otherwise.

log

void log(CouchbaseLogLevel level,
         String msg)

Log a message at the specified level.

Parameters:

msg - the message string to be logged

log

void log(CouchbaseLogLevel level,
         String format,
         Object arg)

Log a message at the specified level according to the specified format and argument.

This form avoids superfluous object creation when the logger is disabled for the specified level.

Parameters:

format - the format string

arg - the argument

log

void log(CouchbaseLogLevel level,
         String format,
         Object argA,
         Object argB)

Log a message at the specified level according to the specified format and arguments.

This form avoids superfluous object creation when the logger is disabled for the specified level.

Parameters:

format - the format string

argA - the first argument

argB - the second argument

log

void log(CouchbaseLogLevel level,
         String format,
         Object... arguments)

Log a message at the specified level according to the specified format and arguments.

This form avoids superfluous string concatenation when the logger is disabled for the specified level. However, this variant incurs the hidden (and relatively small) cost of creating an Object[] before invoking the method, even if this logger is disabled for the specified level. The variants taking one and two arguments exist solely in order to avoid this hidden cost.

Parameters:

format - the format string

arguments - a list of 3 or more arguments

log

void log(CouchbaseLogLevel level,
         String msg,
         Throwable t)

Log an exception (throwable) at the specified level with an accompanying message.

Parameters:

msg - the message accompanying the exception

t - the exception (throwable) to log

log

void log(CouchbaseLogLevel level,
         Throwable t)

Log an exception (throwable) at the specified level.

Parameters:

t - the exception (throwable) to log