com.google.gwt.dev.util.log

Class AbstractTreeLogger

java.lang.Object

com.google.gwt.core.ext.TreeLogger

com.google.gwt.dev.util.log.AbstractTreeLogger

Direct Known Subclasses:

PrintWriterTreeLogger, ServletContextTreeLogger, SwingTreeLogger, ViewerServiceTreeLogger

public abstract class AbstractTreeLogger
extends TreeLogger

Abstract base class for TreeLoggers.

Nested Class Summary

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

TreeLogger.HelpInfo, TreeLogger.Type

Field Summary

Fields

Modifier and Type	Field and Description
static Comparator<String>	LOG_LINE_COMPARATOR
protected TreeLogger.Type	logLevel
protected AbstractTreeLogger	parent

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

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTreeLogger() The constructor used when creating a top-level logger.

Method Summary

Modifier and Type	Method and Description
protected int	allocateNextChildIndex()
TreeLogger	branch(TreeLogger.Type type, String msg, Throwable caught, TreeLogger.HelpInfo helpInfo) Implements branching behavior that supports lazy logging for low-priority branched loggers.
protected void	commitMyBranchEntryInMyParentLogger() Commits the branch after ensuring that the parent logger (if there is one) has been committed first.
protected abstract AbstractTreeLogger	doBranch() Derived classes should override this method to return a branched logger.
protected abstract void	doCommitBranch(AbstractTreeLogger childBeingCommitted, TreeLogger.Type type, String msg, Throwable caught, TreeLogger.HelpInfo helpInfo) Derived classes should override this method to actually commit the specified message associated with this the root of this branch.
protected abstract void	doLog(int indexOfLogEntryWithinParentLogger, TreeLogger.Type type, String msg, Throwable caught, TreeLogger.HelpInfo helpInfo) Derived classes should override this method to actually write a log message.
int	getBranchedIndex()
protected static String	getExceptionName(Throwable e)
TreeLogger.Type	getMaxDetail()
MetricMap	getMetricMap() Returns the MetricMap currently associated with this TreeLogger.
AbstractTreeLogger	getParentLogger()
static String	getStackTraceAsString(Throwable e)
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) Immediately logs or ignores the specified messages, based on the specified message type and this logger's settings.
void	resetMetricMap() Clears this logger's MetricMap.
void	setAmount(MetricName name, long amount) A metric's value should normally be set using MetricName.setAmount(com.google.gwt.core.ext.TreeLogger, long).
void	setMaxDetail(TreeLogger.Type type)
String	toString()

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

Field Detail

LOG_LINE_COMPARATOR

public static final Comparator<String> LOG_LINE_COMPARATOR

logLevel

protected TreeLogger.Type logLevel

parent

protected AbstractTreeLogger parent

Constructor Detail

AbstractTreeLogger

protected AbstractTreeLogger()

The constructor used when creating a top-level logger.

Method Detail

getStackTraceAsString

public static String getStackTraceAsString(Throwable e)

getExceptionName

protected static String getExceptionName(Throwable e)

branch

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

Implements branching behavior that supports lazy logging for low-priority branched loggers.

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

resetMetricMap

public void resetMetricMap()

Clears this logger's MetricMap. If the map was shared with the parent logger, the parent's map will be unchanged and the new map will be independent of its parent.

getBranchedIndex

public final int getBranchedIndex()

getMetricMap

public MetricMap getMetricMap()

Returns the MetricMap currently associated with this TreeLogger.

getMaxDetail

public final TreeLogger.Type getMaxDetail()

getParentLogger

public final AbstractTreeLogger getParentLogger()

isLoggable

public final 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 final void log(TreeLogger.Type type,
                      String msg,
                      Throwable caught,
                      TreeLogger.HelpInfo helpInfo)

Immediately logs or ignores the specified messages, based on the specified message type and this logger's settings. If the message is loggable, then parent branches may be lazily created before the log can take place.

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

setMaxDetail

public final void setMaxDetail(TreeLogger.Type type)

Parameters:

type - the log type representing the most detailed level of logging that the caller is interested in, or null to choose the default level.

toString

public String toString()

Overrides:

toString in class Object

allocateNextChildIndex

protected int allocateNextChildIndex()

commitMyBranchEntryInMyParentLogger

protected void commitMyBranchEntryInMyParentLogger()

Commits the branch after ensuring that the parent logger (if there is one) has been committed first.

doBranch

protected abstract AbstractTreeLogger doBranch()

Derived classes should override this method to return a branched logger.

doCommitBranch

protected abstract void doCommitBranch(AbstractTreeLogger childBeingCommitted,
                                       TreeLogger.Type type,
                                       String msg,
                                       Throwable caught,
                                       TreeLogger.HelpInfo helpInfo)

Derived classes should override this method to actually commit the specified message associated with this the root of this branch.

doLog

protected abstract void doLog(int indexOfLogEntryWithinParentLogger,
                              TreeLogger.Type type,
                              String msg,
                              Throwable caught,
                              TreeLogger.HelpInfo helpInfo)

Derived classes should override this method to actually write a log message. Note that isLoggable(TreeLogger.Type) will have already been called.

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).