cz.cuni.amis.pogamut.base.utils.logging

Class LogCategory

java.lang.Object

java.util.logging.Logger

cz.cuni.amis.pogamut.base.utils.logging.LogCategory

All Implemented Interfaces:

Comparable<LogCategory>

Direct Known Subclasses:

LogCategoryJMXProxy

public class LogCategory
extends Logger
implements Comparable<LogCategory>

Instance that serves as a gateway for your log messages.

The trick with categories is that every log record may contain object parameters. So we're appending instance of this class as a very first parameter to the log record and filter those messages according to them.

Author:

Jimmy

Field Summary

Fields inherited from class java.util.logging.Logger

global, GLOBAL_LOGGER_NAME

Constructor Summary

Constructors

Constructor and Description
LogCategory(String categoryName)
LogCategory(String categoryName, Logger parent)

Method Summary

Methods

Modifier and Type	Method and Description
LogCategory	addConsoleHandler() Adds default console handler with 'Platform' (== platform logging) agent id.
LogHandler	addHandler() Returns new LogHandler with null ILogPublisher that is appended to the logger and filters log messages for this category.
LogHandler	addHandler(ILogPublisher publisher) Returns new LogHandler with specified ILogPublisher that is appended to the logger and filters log messages for this category.
LogEventMark	addLogEvent(Level level, String text) Add new log event to the log, event won't end, until removed using LogCategory#removeLogEvent(java.lang.Object) .
void	addLogEvent(Level level, String text, long duration) Add new log event to the log, the event starts now.
void	addLogMessage(Level level, String text) Add log message to the log.
LogMapMark	addMapMark(Level level, String msg, Location location) Add mark to the map.
void	addMapMark(Level level, String msg, Location location, long duration) Add mark to the map for specified time and add notice to the logs.
int	compareTo(LogCategory o)
void	fine(String msg)
void	fine(String msg, Object param)
void	fine(String msg, Object[] params)
void	finer(String msg)
void	finer(String msg, Object param)
void	finer(String msg, Object[] params)
void	finest(String msg)
void	finest(String msg, Object param)
void	finest(String msg, Object[] params)
String	getCategoryName()
void	info(String msg)
void	info(String msg, Object param)
void	info(String msg, Object[] params)
void	log(Level level, String msg)
void	log(Level level, String msg, Object param)
void	log(Level level, String msg, Object[] params) All other logging methods is calling this one.
void	removeLogEvent(LogEventMark mark) Remove log event with undefined duration.
void	removeMapMark(LogMapMark mark) Remove mark from the map.
void	setLevel(Level logLevel)
void	severe(String msg)
void	severe(String msg, Object param)
void	severe(String msg, Object[] params)
String	toString()
void	warning(String msg)
void	warning(String msg, Object param)
void	warning(String msg, Object[] params)

Methods inherited from class java.util.logging.Logger

addHandler, config, entering, entering, entering, exiting, exiting, getAnonymousLogger, getAnonymousLogger, getFilter, getGlobal, getHandlers, getLevel, getLogger, getLogger, getName, getParent, getResourceBundle, getResourceBundleName, getUseParentHandlers, isLoggable, log, log, logp, logp, logp, logp, logrb, logrb, logrb, logrb, removeHandler, setFilter, setParent, setUseParentHandlers, throwing

Methods inherited from class java.lang.Object

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

Constructor Detail

LogCategory

public LogCategory(String categoryName)

LogCategory

public LogCategory(String categoryName,
           Logger parent)

Method Detail

getCategoryName

public String getCategoryName()

setLevel

public void setLevel(Level logLevel)
              throws SecurityException

Overrides:

setLevel in class Logger

Throws:

SecurityException

addConsoleHandler

public LogCategory addConsoleHandler()

Adds default console handler with 'Platform' (== platform logging) agent id.

Use only when using LogCategory separately, i.e., outside IAgentLogger.

Returns:

this instance

addHandler

public LogHandler addHandler()

Returns new LogHandler with null ILogPublisher that is appended to the logger and filters log messages for this category.

The handler will use LogPublisher.ConsolePublisher as default.

This is the quickest way to obtain new output from the log.

Returns:

addHandler

public LogHandler addHandler(ILogPublisher publisher)

Returns new LogHandler with specified ILogPublisher that is appended to the logger and filters log messages for this category.

The handler will use LogPublisher.ConsolePublisher as default.

This is the quickest way to obtain new output from the log.

Returns:

log

public void log(Level level,
       String msg,
       Object[] params)

All other logging methods is calling this one. Synchronized!

Overrides:

log in class Logger

log

public void log(Level level,
       String msg)

Overrides:

log in class Logger

log

public void log(Level level,
       String msg,
       Object param)

Overrides:

log in class Logger

finest

public void finest(String msg)

Overrides:

finest in class Logger

finest

public void finest(String msg,
          Object param)

finest

public void finest(String msg,
          Object[] params)

finer

public void finer(String msg)

Overrides:

finer in class Logger

finer

public void finer(String msg,
         Object param)

finer

public void finer(String msg,
         Object[] params)

fine

public void fine(String msg)

Overrides:

fine in class Logger

fine

public void fine(String msg,
        Object param)

fine

public void fine(String msg,
        Object[] params)

info

public void info(String msg)

Overrides:

info in class Logger

info

public void info(String msg,
        Object param)

info

public void info(String msg,
        Object[] params)

warning

public void warning(String msg)

Overrides:

warning in class Logger

warning

public void warning(String msg,
           Object param)

warning

public void warning(String msg,
           Object[] params)

severe

public void severe(String msg)

Overrides:

severe in class Logger

severe

public void severe(String msg,
          Object param)

severe

public void severe(String msg,
          Object[] params)

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(LogCategory o)

Specified by:

compareTo in interface Comparable<LogCategory>

addMapMark

public void addMapMark(Level level,
              String msg,
              Location location,
              long duration)

Add mark to the map for specified time and add notice to the logs.

Parameters:

level - What level is this mark? If too low, it can be filtered out.

msg - What text should be shown on the map at the specified place.

location - Location, where should be mark placed. If null, mark will follow the agent.

duration - How long should be mark shown? In ms.

addMapMark

public LogMapMark addMapMark(Level level,
                    String msg,
                    Location location)

Add mark to the map. If you want to remove the mark, use LogCategory#removeMapMark(java.lang.Object)

Parameters:

level - What level is this mark? If too low, it can be filtered out.

msg - What text should be shown on the map at the specified place.

location - Location, where should be mark placed. If null, mark will follow the agent.

Returns:

object that can be later used in LogCategory#removeMapMark(java.lang.Object) in order to remove the mark from the map.

removeMapMark

public void removeMapMark(LogMapMark mark)

Remove mark from the map. Mark should be previosly inserted using addMapMark(java.util.logging.Level, java.lang.String, cz.cuni.amis.pogamut.base3d.worldview.object.Location)

Parameters:

mark - object that was returned by addMapMark(java.util.logging.Level, java.lang.String, cz.cuni.amis.pogamut.base3d.worldview.object.Location) during addition of mark to the map.

addLogMessage

public void addLogMessage(Level level,
                 String text)

Add log message to the log. Log message is log event with zero duration.

Parameters:

text - text of log message.

addLogEvent

public void addLogEvent(Level level,
               String text,
               long duration)

Add new log event to the log, the event starts now.

Parameters:

level - level of event.

text - text of event

duration - how long should event last?

addLogEvent

public LogEventMark addLogEvent(Level level,
                       String text)

Add new log event to the log, event won't end, until removed using LogCategory#removeLogEvent(java.lang.Object) .

Parameters:

level - level of event.

text - text of event

Returns:

object that can be later used in LogCategory#removeLogEvent(java.lang.Object) in order to remove the event from the log.

removeLogEvent

public void removeLogEvent(LogEventMark mark)

Remove log event with undefined duration. The event should be created by addLogEvent(java.util.logging.Level, java.lang.String)

Parameters:

mark - object returned by addLogEvent(java.util.logging.Level, java.lang.String) during addition of log event to the log.