io.github.robolib.util.log

Class Logger

java.lang.Object

io.github.robolib.util.log.ILogger

io.github.robolib.util.log.Logger

public final class Logger
extends ILogger

A Logging class for the robot.

Each Class that wishes to log must call the Logger.get method with itself as the only argument. This will return a new Logger object.

To log something, the Calling class must call the desired level method info, debug, warn, error, fatal with the message to be logged. If the calling the err or fatal classes, a Throwable object must be passed as a second argument. Calling the error method will only print the message and error stack trace. However, calling the fatal method will print the stack trace, and kill the robot.

Author:

noriah

See Also:

ILogger, LogOutput, LogLevel

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.List<LogOutput>	DEFAULT_OUTS The Constant m_defOuts.
private static java.util.Map<java.lang.Object,Logger>	LOGGERS The Constant m_loggers.
private boolean	m_acceptGlobals The m_acceptGlobals.
private static boolean	m_debugEnabled The m_debugEnabled.
private java.lang.String	m_label The m_label.
private java.util.List<LogOutput>	m_outs The m_outs.
static LogOutput	TERM_ERR The Constant TERM_ERR.
static LogOutput	TERM_OUT The Constant TERM_OUT.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	Logger(java.lang.String label) Instantiates a new logger.

Method Summary

Modifier and Type	Method and Description
void	clearOutputs()
void	debug(java.lang.String s) Log an String to the logger, with debug status.
void	enableDebug(boolean enable) Enable the output of debug statements.
void	error(java.lang.String s, java.lang.Object o) Log an String to the logger, with error status.
void	fatal(java.lang.String s, java.lang.Object o) Log an String to the logger, with fatal status.
static LogOutput	fileOutput(java.lang.String s) File output.
static ILogger	get(java.lang.Class c) Get an ILogger instance for c.
static ILogger	get(java.lang.Object o) Get an ILogger instance for o.
static Logger	get(java.lang.Object o, java.lang.String s) Get an ILogger instance for c.
void	info(java.lang.String s) Log an String to the logger, with info status.
void	log(LogLevel lvl, java.lang.String s) Log an String to the logger, with log status.
static void	registerDefaultFileOutput(java.lang.String s) Register default file output.
static void	registerDefaultOutput(LogOutput out) Adds a LogOutput to the list of default outputs.
void	registerOutput(LogOutput out) Add an output to the logger for this object.
static void	registerToAll(LogOutput out) Add an output to all the loggers.
private void	sendErrMsg(LogLevel l, java.lang.String s) Log an error message.
private void	sendMsg(LogLevel l, java.lang.String s) Log a message.
void	severe(java.lang.String s, java.lang.Object o) Log an String to the logger, with severe status.
void	warn(java.lang.String s) Log an String to the logger, with warning status.

Methods inherited from class io.github.robolib.util.log.ILogger

debug, debug, debug, debug, debug, debug, debug, debug, enableDebug, error, error, error, error, error, error, error, error, error, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, info, info, info, info, info, info, info, info, log, log, log, log, log, log, log, log, severe, severe, severe, severe, severe, severe, severe, severe, severe, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class java.lang.Object

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

Field Detail

LOGGERS

private static final java.util.Map<java.lang.Object,Logger> LOGGERS

The Constant m_loggers.

DEFAULT_OUTS

private static final java.util.List<LogOutput> DEFAULT_OUTS

The Constant m_defOuts.

m_debugEnabled

private static boolean m_debugEnabled

The m_debugEnabled.

m_outs

private final java.util.List<LogOutput> m_outs

The m_outs.

m_label

private final java.lang.String m_label

The m_label.

m_acceptGlobals

private boolean m_acceptGlobals

The m_acceptGlobals.

TERM_OUT

public static final LogOutput TERM_OUT

The Constant TERM_OUT.

TERM_ERR

public static final LogOutput TERM_ERR

The Constant TERM_ERR.

Constructor Detail

Logger

private Logger(java.lang.String label)

Instantiates a new logger.

Parameters:

label - the label

Method Detail

get

public static ILogger get(java.lang.Object o)

Get an ILogger instance for o.

Parameters:

o - the object to get the logger for.

Returns:

an ILogger instance

get

public static ILogger get(java.lang.Class c)

Get an ILogger instance for c.

Parameters:

c - the class to get the logger for.

Returns:

an ILogger instance

get

public static Logger get(java.lang.Object o,
                         java.lang.String s)

Get an ILogger instance for c.

Parameters:

o - the object to get the logger for.

s - the string to be prefixed to log messages.

Returns:

an ILogger instance

fileOutput

public static LogOutput fileOutput(java.lang.String s)

File output.

Parameters:

s - the s

Returns:

the log output

registerDefaultOutput

public static void registerDefaultOutput(LogOutput out)

Adds a LogOutput to the list of default outputs. Also adds the output to all of the current Loggers. (If they don't already have it)

Parameters:

out - a LogOutput instance

registerDefaultFileOutput

public static void registerDefaultFileOutput(java.lang.String s)

Register default file output.

Parameters:

s - the s

registerOutput

public void registerOutput(LogOutput out)

Add an output to the logger for this object. Adding a new output will add that output to the list so that it will output log data same as the console.

Specified by:

registerOutput in class ILogger

Parameters:

out - a LogOutput instance

clearOutputs

public void clearOutputs()

enableDebug

public void enableDebug(boolean enable)

Enable the output of debug statements.

Specified by:

enableDebug in class ILogger

Parameters:

enable - enable the output of debug statements

registerToAll

public static void registerToAll(LogOutput out)

Add an output to all the loggers.

Parameters:

out - a LogOutput instance

sendMsg

private void sendMsg(LogLevel l,
                     java.lang.String s)

Log a message.

Parameters:

l - the Logging level

s - the String to log

sendErrMsg

private void sendErrMsg(LogLevel l,
                        java.lang.String s)

Log an error message.

Parameters:

l - the Logging level

s - the String to log

log

public void log(LogLevel lvl,
                java.lang.String s)

Log an String to the logger, with log status.

Specified by:

log in class ILogger

Parameters:

lvl - the LogLevel to send with this message

s - the String to log

info

public void info(java.lang.String s)

Log an String to the logger, with info status.

Specified by:

info in class ILogger

Parameters:

s - the String to log

debug

public void debug(java.lang.String s)

Log an String to the logger, with debug status.

Specified by:

debug in class ILogger

Parameters:

s - the String to log

warn

public void warn(java.lang.String s)

Log an String to the logger, with warning status.

Specified by:

warn in class ILogger

Parameters:

s - the String to log

error

public void error(java.lang.String s,
                  java.lang.Object o)

Log an String to the logger, with error status.

Specified by:

error in class ILogger

Parameters:

s - the String to log

o - the Object to send with the message

severe

public void severe(java.lang.String s,
                   java.lang.Object o)

Log an String to the logger, with severe status. If the exception passed to this method is an Error or Runtime Exception, the Program will Quit

Specified by:

severe in class ILogger

Parameters:

s - the String to log

o - the Object to send with the message

fatal

public void fatal(java.lang.String s,
                  java.lang.Object o)

Log an String to the logger, with fatal status. Program will exit with status 1

Specified by:

fatal in class ILogger

Parameters:

s - the String to log

o - the Object to send with the message