org.apache.velocity.tools.config
Class LogSupport

java.lang.Object
  org.apache.velocity.tools.config.LogSupport

Direct Known Subclasses:

ConfigurationCleaner

public abstract class LogSupport
extends java.lang.Object

This allows for a Log to optionally be attached to a subclass in order to output logging messages. This is simpler than constantly checking whether we have a Log or not in each usage throughout the classes which could use logging. Methods should only be added to this as necessary. Performance considerations can also be made later if deemed necessary. This is meant for internal use and should NOT be relied upon by VelocityTools users.

Version:

$Id: LogSupport.java 511959 2007-02-26 19:24:39Z nbubna $

Author:

Nathan Bubna

Field Summary

private static java.lang.String	DEFAULT_PREFIX
private org.apache.velocity.runtime.log.Log	log

Constructor Summary

LogSupport()

Method Summary

protected void	debug(java.lang.String msg)
protected org.apache.velocity.runtime.log.Log	getLog()
protected boolean	isDebugEnabled()
protected boolean	isTraceEnabled()
protected boolean	isWarnEnabled()
protected java.lang.String	logPrefix() Override this to set a class-specific prefix
void	setLog(org.apache.velocity.runtime.log.Log log)
protected void	trace(java.lang.String msg)
protected void	warn(java.lang.String msg)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PREFIX

private static final java.lang.String DEFAULT_PREFIX

See Also:

Constant Field Values

log

private org.apache.velocity.runtime.log.Log log

Constructor Detail

LogSupport

public LogSupport()

Method Detail

logPrefix

protected java.lang.String logPrefix()

Override this to set a class-specific prefix

setLog

public void setLog(org.apache.velocity.runtime.log.Log log)

getLog

protected org.apache.velocity.runtime.log.Log getLog()

isWarnEnabled

protected boolean isWarnEnabled()

warn

protected void warn(java.lang.String msg)

isDebugEnabled

protected boolean isDebugEnabled()

debug

protected void debug(java.lang.String msg)

isTraceEnabled

protected boolean isTraceEnabled()

trace

protected void trace(java.lang.String msg)