com.aldebaran.qi.log

Class LogReport

java.lang.Object

com.aldebaran.qi.log.LogReport

public class LogReport
extends Object

Capture log and permits to report them to a LogCatcher

Constructor Summary

Constructors

Constructor and Description
LogReport()

Method Summary

Methods

Modifier and Type	Method and Description
static void	debug(String message) Publish a debug log
static void	error(String message) Publish a error log
static void	fatal(String message) Publish a fatal log
static void	information(String message) Publish a information log
static void	log(LogLevel logLevel, String message) Publish a log
static void	register(LogCatcher logCatcher, LogLevel... logLevels) Register a LogCatcher for specified log levels. For LogLevel.SILENT nothing is register, since its means no log report.
static void	registerAtLeast(LogCatcher logCatcher, LogLevel logLevel) Register LogCatcher for given logLevel and all more important that given one. Importance log level from more important to less is: LogLevel.FATAL LogLevel.ERROR LogLevel.WARNING LogLevel.INFORMATION LogLevel.VERBOSE LogLevel.DEBUG Note that LogLevel.SILENT is a special level for no log at all
static void	unregister(LogCatcher logCatcher, LogLevel... logLevels) Unregister a LogCatcher for specified log levels.
static void	unregisterAll(LogCatcher logCatcher) Unregister all log level that a given LogCatcher is registered for
static void	unregisterAtMost(LogCatcher logCatcher, LogLevel logLevel) Register LogCatcher for given logLevel and all less important that given one. Importance log level from more important to less is: LogLevel.FATAL LogLevel.ERROR LogLevel.WARNING LogLevel.INFORMATION LogLevel.VERBOSE LogLevel.DEBUG Note that LogLevel.SILENT is a special level for no log at all
static void	verbose(String message) Publish a verbose log
static void	warning(String message) Publish a warning log

Methods inherited from class java.lang.Object

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

Constructor Detail

LogReport

public LogReport()

Method Detail

register

public static void register(LogCatcher logCatcher,
            LogLevel... logLevels)

Register a LogCatcher for specified log levels.
For LogLevel.SILENT nothing is register, since its means no log report.

Parameters:

logCatcher - LogCatcher to register, must not be null

logLevels - Log levels to be alert. LogLevel.SILENT or null does nothing

Throws:

NullPointerException - If given logCatcher is null

registerAtLeast

public static void registerAtLeast(LogCatcher logCatcher,
                   LogLevel logLevel)

Register LogCatcher for given logLevel and all more important that given one.
Importance log level from more important to less is:

1. LogLevel.FATAL
2. LogLevel.ERROR
3. LogLevel.WARNING
4. LogLevel.INFORMATION
5. LogLevel.VERBOSE
6. LogLevel.DEBUG

Note that LogLevel.SILENT is a special level for no log at all

Parameters:

logCatcher - LogCatcher to register

logLevel - Minimum level to capture

Throws:

NullPointerException - If logCatcher or logLevel is null

unregister

public static void unregister(LogCatcher logCatcher,
              LogLevel... logLevels)

Unregister a LogCatcher for specified log levels.

Parameters:

logCatcher - LogCatcher to unregister, must not be null

logLevels - Log levels to stop be alert.

Throws:

NullPointerException - If given logCatcher is null

unregisterAtMost

public static void unregisterAtMost(LogCatcher logCatcher,
                    LogLevel logLevel)

Register LogCatcher for given logLevel and all less important that given one.
Importance log level from more important to less is:

1. LogLevel.FATAL
2. LogLevel.ERROR
3. LogLevel.WARNING
4. LogLevel.INFORMATION
5. LogLevel.VERBOSE
6. LogLevel.DEBUG

Note that LogLevel.SILENT is a special level for no log at all

Parameters:

logCatcher - LogCatcher to register

logLevel - Maximum level to stop to capture

Throws:

NullPointerException - If logCatcher or logLevel is null

unregisterAll

public static void unregisterAll(LogCatcher logCatcher)

Unregister all log level that a given LogCatcher is registered for

Parameters:

logCatcher - LogCatcher to unregister for

Throws:

NullPointerException - If given logCatcher is null

log

public static void log(LogLevel logLevel,
       String message)

Publish a log

Parameters:

logLevel - Log level

message - Message to publish

Throws:

NullPointerException - If logLevel or message is null

fatal

public static void fatal(String message)

Publish a fatal log

Parameters:

message - Fatal message

Throws:

NullPointerException - If message is null

error

public static void error(String message)

Publish a error log

Parameters:

message - Error message

Throws:

NullPointerException - If message is null

warning

public static void warning(String message)

Publish a warning log

Parameters:

message - Warning message

Throws:

NullPointerException - If message is null

information

public static void information(String message)

Publish a information log

Parameters:

message - Information message

Throws:

NullPointerException - If message is null

verbose

public static void verbose(String message)

Publish a verbose log

Parameters:

message - Verbose message

Throws:

NullPointerException - If message is null

debug

public static void debug(String message)

Publish a debug log

Parameters:

message - Debug message

Throws:

NullPointerException - If message is null