com.proofpoint.log

Class Logger

java.lang.Object

com.proofpoint.log.Logger

public class Logger
extends Object

Method Summary

Methods

Modifier and Type	Method and Description
void	debug(String format, Object... args) Logs a message at DEBUG level.
void	debug(Throwable exception, String format, Object... args) Logs a message at DEBUG level.
void	error(String format, Object... args) Logs a message at ERROR level.
void	error(Throwable exception) Logs a message at ERROR level.
void	error(Throwable exception, String format, Object... args) Logs a message at ERROR level.
static Logger	get(Class<?> clazz) Gets a logger named after a class' fully qualified name.
static Logger	get(String name) Gets a named logger
void	info(String format, Object... args) Logs a message at INFO level.
boolean	isDebugEnabled()
boolean	isInfoEnabled()
void	warn(String format, Object... args) Logs a message at WARN level.
void	warn(Throwable exception, String format, Object... args) Logs a message at WARN level.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

get

public static Logger get(Class<?> clazz)

Gets a logger named after a class' fully qualified name.

Parameters:

clazz - the class

Returns:

the named logger

get

public static Logger get(String name)

Gets a named logger

Parameters:

name - the name of the logger

Returns:

the named logger

debug

public void debug(String format,
         Object... args)

Logs a message at DEBUG level.
Usage example:

    logger.debug("value is %s (%d ms)", value, time);
 

If the format string is invalid or the arguments are insufficient, an error will be logged and execution will continue.

Parameters:

format - a format string compatible with String.format()

args - arguments for the format string

debug

public void debug(Throwable exception,
         String format,
         Object... args)

Logs a message at DEBUG level.
Usage example:

    logger.debug(e, "value is %s (%d ms)", value, time);
 

If the format string is invalid or the arguments are insufficient, an error will be logged and execution will continue.

Parameters:

exception - an exception associated with the debug message being logged

format - a format string compatible with String.format()

args - arguments for the format string

info

public void info(String format,
        Object... args)

Logs a message at INFO level.
Usage example:

    logger.info("value is %s (%d ms)", value, time);
 

If the format string is invalid or the arguments are insufficient, an error will be logged and execution will continue.

Parameters:

format - a format string compatible with String.format()

args - arguments for the format string

warn

public void warn(Throwable exception,
        String format,
        Object... args)

Logs a message at WARN level.
Usage example:

    logger.warn(e, "something bad happened when connecting to %s:%d", host, port);
 

If the format string is invalid or the arguments are insufficient, an error will be logged and execution will continue.

Parameters:

exception - an exception associated with the warning being logged

format - a format string compatible with String.format()

args - arguments for the format string

warn

public void warn(String format,
        Object... args)

Logs a message at WARN level.
Usage example:

    logger.warn("something bad happened when connecting to %s:%d", host, port);
 

If the format string is invalid or the arguments are insufficient, an error will be logged and execution will continue.

Parameters:

format - a format string compatible with String.format()

args - arguments for the format string

error

public void error(Throwable exception,
         String format,
         Object... args)

Logs a message at ERROR level.
Usage example:

    logger.error(e, "something really bad happened when connecting to %s:%d", host, port);
 

If the format string is invalid or the arguments are insufficient, an error will be logged and execution will continue.

Parameters:

exception - an exception associated with the error being logged

format - a format string compatible with String.format()

args - arguments for the format string

error

public void error(Throwable exception)

Logs a message at ERROR level. The value of exception.getMessage() will be used as the log message.
Usage example:

    logger.error(e);
 

Parameters:

exception - an exception associated with the error being logged

error

public void error(String format,
         Object... args)

Logs a message at ERROR level.
Usage example:

    logger.error("something really bad happened when connecting to %s:%d", host, port);
 

If the format string is invalid or the arguments are insufficient, an error will be logged and execution will continue.

Parameters:

format - a format string compatible with String.format()

args - arguments for the format string

isDebugEnabled

public boolean isDebugEnabled()

isInfoEnabled

public boolean isInfoEnabled()