org.yarnandtail.andhow.util

Class AndHowLog

java.lang.Object

org.yarnandtail.andhow.util.AndHowLog

public class AndHowLog
extends Object

A simple wrapper around the java.util.Logging utility that makes it behave more like SLF4J, including more use of standard message formatting. Methods that take Object... arguments use curly brace replacement, ie:
debug("Hello ''{0}'', Welcome to logging", "Carl");,
Logs: Hello 'Carl', Welcome to logging
(Note that single quotes must be doubled up).

Configuration of logging levels happens can be done in three ways:

• Explicitly calling setLevel() on a AndHowLog instance
• Setting a System property of the form [canonical name of class being logged].level=[Level name]|Level number]. Note that these System properties are read at the time of construction. If modified for a particular logger, reloadLogLevel() must be called on the AndHowLog to pick up the change.
• Finally, the file based mechanism used by java.util.logging.LogManager is used, however, this mechanism is impractical for most application level logging configurations.

Author:

ericeverman

Method Summary

Modifier and Type	Method and Description
void	addHandler(Handler handler)
void	debug(String msg)
void	debug(String format, Object... arguments)
void	debug(String msg, Throwable t)
void	error(String msg)
void	error(String format, Object... arguments)
void	error(String msg, Throwable t)
Handler[]	getHandlers()
static AndHowLog	getLogger(Class<?> clazz)
static AndHowLog	getLogger(Class<?> clazz, Handler handler)
void	info(String msg)
void	info(String format, Object... arguments)
void	info(String msg, Throwable t)
boolean	isLoggable(Level level) Check if a message of the given level would actually be logged by this logger.
void	mandatoryNote(String format, Object... arguments) Log a manditory note.
void	removeHandler(Handler handler)
void	setLevel(Level newLevel) Assigns a log level.
void	trace(String msg)
void	trace(String format, Object... arguments)
void	trace(String msg, Throwable t)
void	warn(String msg)
void	warn(String format, Object... arguments)
void	warn(String msg, Throwable t)

Methods inherited from class java.lang.Object

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

Method Detail

getLogger

public static AndHowLog getLogger(Class<?> clazz)

getLogger

public static AndHowLog getLogger(Class<?> clazz,
                                  Handler handler)

setLevel

public void setLevel(Level newLevel)
              throws SecurityException

Assigns a log level. This AndHowLog accepts System properties to assign a log level. Explicitly setting a null Level will re-read the level specified in Sys props, or if non, default to the java.util.AndHowLog interpretation of null.

Parameters:

newLevel -

Throws:

SecurityException

getHandlers

public Handler[] getHandlers()

addHandler

public void addHandler(Handler handler)

removeHandler

public void removeHandler(Handler handler)

isLoggable

public boolean isLoggable(Level level)

Check if a message of the given level would actually be logged by this logger. This check is based on the Loggers effective level, which may be inherited from its parent.

Parameters:

level - a message logging level

Returns:

true if the given message level is currently being logged.

mandatoryNote

public void mandatoryNote(String format,
                          Object... arguments)

Log a manditory note.

This was created for the case where sample configuration is written to a tmp directory, possibly at the user's request. The message must be displayed or the user will not know where samples were written, but it should not look like an error.

Parameters:

format - The format string to use

arguments - In-order arguments to be replaced in the string.

trace

public void trace(String msg)

trace

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

trace

public void trace(String msg,
                  Throwable t)

debug

public void debug(String msg)

debug

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

debug

public void debug(String msg,
                  Throwable t)

info

public void info(String msg)

info

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

info

public void info(String msg,
                 Throwable t)

warn

public void warn(String msg)

warn

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

warn

public void warn(String msg,
                 Throwable t)

error

public void error(String msg)

error

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

error

public void error(String msg,
                  Throwable t)