com.allanbank.mongodb.util.log

Interface Log

All Known Implementing Classes:

AbstractLog, JulLog, Slf4jLog

public interface Log

Log is the simplified logging interface used by the driver. It will dynamically wrap either SLF4J (if available) or Java Util Logging (as a fall-back).

API Warning:

This class is NOT part of the drivers API. This class may be mutated in incompatible ways between any two releases of the driver.

Copyright ©:

2014, Allanbank Consulting, Inc., All Rights Reserved

Field Summary

Fields

Modifier and Type	Field and Description
static String	REPLACE_TOKEN The token to replace with the arguments to the log message.

Method Summary

Methods

Modifier and Type	Method and Description
void	debug(String message) Logs a message at the DEBUG level.
void	debug(String template, Object... args) Logs a message at the DEBUG level.
void	debug(Throwable thrown, String template, Object... args) Logs a message at the DEBUG level.
void	error(String message) Logs a message at the ERROR level.
void	error(String template, Object... args) Logs a message at the ERROR level.
void	error(Throwable thrown, String template, Object... args) Logs a message at the ERROR level.
void	info(String message) Logs a message at the Level.INFO level.
void	info(String template, Object... args) Logs a message at the INFO level.
void	info(Throwable thrown, String template, Object... args) Logs a message at the INFO level.
void	log(Level level, String message) Logs a message at the specified level.
void	log(Level level, String template, Object... args) Logs a message at the specified level.
void	log(Level level, Throwable thrown, String template, Object... args) Logs a message at the specified level.
void	warn(String message) Logs a message at the Level.WARNING level.
void	warn(String template, Object... args) Logs a message at the WARNING level.
void	warn(Throwable thrown, String template, Object... args) Logs a message at the WARNING level.

Field Detail

REPLACE_TOKEN

static final String REPLACE_TOKEN

The token to replace with the arguments to the log message. Unlike SLF4J we do support escaping of this token.

See Also:

Constant Field Values

Method Detail

debug

void debug(String message)

Logs a message at the DEBUG level.

Parameters:

message - The message to log.

debug

void debug(String template,
         Object... args)

Logs a message at the DEBUG level.

Parameters:

template - The message template to log.

args - The arguments to replace the {} entries in the template.

debug

void debug(Throwable thrown,
         String template,
         Object... args)

Logs a message at the DEBUG level.

Parameters:

thrown - The exception associated with the log message.

template - The message template to log.

args - The arguments to replace the {} entries in the template.

error

void error(String message)

Logs a message at the ERROR level.

Parameters:

message - The message to log.

error

void error(String template,
         Object... args)

Logs a message at the ERROR level.

Parameters:

template - The message template to log.

args - The arguments to replace the {} entries in the template.

error

void error(Throwable thrown,
         String template,
         Object... args)

Logs a message at the ERROR level.

Parameters:

thrown - The exception associated with the log message.

template - The message template to log.

args - The arguments to replace the {} entries in the template.

info

void info(String message)

Logs a message at the Level.INFO level.

Parameters:

message - The message to log.

info

void info(String template,
        Object... args)

Logs a message at the INFO level.

Parameters:

template - The message template to log.

args - The arguments to replace the {} entries in the template.

info

void info(Throwable thrown,
        String template,
        Object... args)

Logs a message at the INFO level.

Parameters:

thrown - The exception associated with the log message.

template - The message template to log.

args - The arguments to replace the {} entries in the template.

log

void log(Level level,
       String message)

Logs a message at the specified level.

Parameters:

level - The logging level for the message.

message - The message to log.

log

void log(Level level,
       String template,
       Object... args)

Logs a message at the specified level.

Parameters:

level - The logging level for the message.

template - The message template to log.

args - The arguments to replace the {} entries in the template.

log

void log(Level level,
       Throwable thrown,
       String template,
       Object... args)

Logs a message at the specified level.

Parameters:

level - The logging level for the message.

thrown - The exception associated with the log message.

template - The message template to log.

args - The arguments to replace the {} entries in the template.

warn

void warn(String message)

Logs a message at the Level.WARNING level.

Parameters:

message - The message to log.

warn

void warn(String template,
        Object... args)

Logs a message at the WARNING level.

Parameters:

template - The message template to log.

args - The arguments to replace the {} entries in the template.

warn

void warn(Throwable thrown,
        String template,
        Object... args)

Logs a message at the WARNING level.

Parameters:

thrown - The exception associated with the log message.

template - The message template to log.

args - The arguments to replace the {} entries in the template.