com.google.gwt.dev.util.log

Class CompositeTreeLogger

java.lang.Object

com.google.gwt.core.ext.TreeLogger

com.google.gwt.dev.util.log.CompositeTreeLogger

public class CompositeTreeLogger
extends TreeLogger

Forks logging over two child loggers. This provides the graphics + file logging of DevModeBase's -logfile option.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.core.ext.TreeLogger

TreeLogger.HelpInfo, TreeLogger.Type

Field Summary

Fields inherited from class com.google.gwt.core.ext.TreeLogger

ALL, DEBUG, ERROR, INFO, NULL, SPAM, TRACE, WARN

Constructor Summary

Constructors

Constructor and Description
CompositeTreeLogger(TreeLogger... loggers)

Method Summary

Modifier and Type	Method and Description
TreeLogger	branch(TreeLogger.Type type, String msg, Throwable caught, TreeLogger.HelpInfo helpInfo) Produces a branched logger, which can be used to write messages that are logically grouped together underneath the current logger.
boolean	isLoggable(TreeLogger.Type type) Determines whether or not a log entry of the specified type would actually be logged.
void	log(TreeLogger.Type type, String msg, Throwable caught, TreeLogger.HelpInfo helpInfo) Logs a message and/or an exception, with optional help info.
void	setAmount(MetricName name, long amount) A metric's value should normally be set using MetricName.setAmount(com.google.gwt.core.ext.TreeLogger, long).

Methods inherited from class com.google.gwt.core.ext.TreeLogger

branch, branch, log, log

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, toString

Constructor Detail

CompositeTreeLogger

public CompositeTreeLogger(TreeLogger... loggers)

Method Detail

branch

public TreeLogger branch(TreeLogger.Type type,
                         String msg,
                         Throwable caught,
                         TreeLogger.HelpInfo helpInfo)

Description copied from class: TreeLogger

Produces a branched logger, which can be used to write messages that are logically grouped together underneath the current logger. The details of how/if the resulting messages are displayed is implementation-dependent.

The log message supplied when branching serves two purposes. First, the message should be considered a heading for all the child messages below it. Second, the type of the message provides a hint as to the importance of the children below it. As an optimization, an implementation could return a "no-op" logger if messages of the specified type weren't being logged, which the implication being that all nested log messages were no more important than the level of their branch parent.

As an example of how hierarchical logging can be used, a branched logger in a GUI could write log message as child items of a parent node in a tree control. If logging to streams, such as a text console, the branched logger could prefix each entry with a unique string and indent its text so that it could be sorted later to reconstruct a proper hierarchy.

Specified by:

branch in class TreeLogger

msg - an optional message to log, which can be null if only an exception is being logged

caught - an optional exception to log, which can be null if only a message is being logged

helpInfo - extra information that might be used by the logger to provide extended information to the user

Returns:

an instance of TreeLogger representing the new branch of the log; may be the same instance on which this method is called

isLoggable

public boolean isLoggable(TreeLogger.Type type)

Description copied from class: TreeLogger

Determines whether or not a log entry of the specified type would actually be logged. Caller use this method to avoid constructing log messages that would be thrown away.

Specified by:

isLoggable in class TreeLogger

log

public void log(TreeLogger.Type type,
                String msg,
                Throwable caught,
                TreeLogger.HelpInfo helpInfo)

Description copied from class: TreeLogger

Logs a message and/or an exception, with optional help info. It is also legal to call this method using null arguments for both msg and caught, in which case the log event can be ignored. The info can provide extra information to the logger; a logger may choose to ignore this info.

Specified by:

log in class TreeLogger

msg - an optional message to log, which can be null if only an exception is being logged

caught - an optional exception to log, which can be null if only a message is being logged

helpInfo - extra information that might be used by the logger to provide extended information to the user

setAmount

public void setAmount(MetricName name,
                      long amount)

A metric's value should normally be set using MetricName.setAmount(com.google.gwt.core.ext.TreeLogger, long).