org.apache.velocity.runtime.log
Interface LogChute

All Known Implementing Classes:

AvalonLogChute, AvalonLogSystem, JdkLogChute, Log4JLogChute, Log4JLogSystem, LogChuteSystem, NullLogChute, NullLogSystem, PrimordialLogSystem, SystemLogChute

public interface LogChute

Base interface that logging systems need to implement. This is the blessed descendant of the old LogSystem interface.

Version:

$Id: LogChute.java 494611 2007-01-09 21:57:20Z henning $

Author:

Jon S. Stevens, Geir Magnusson Jr., Nathan Bubna

Field Summary

static int	DEBUG_ID ID for debug messages.
static String	DEBUG_PREFIX Prefix string for debug messages.
static int	ERROR_ID ID for error messages.
static String	ERROR_PREFIX Prefix string for error messages.
static int	INFO_ID ID for info messages.
static String	INFO_PREFIX Prefix string for info messages.
static int	TRACE_ID ID for trace messages.
static String	TRACE_PREFIX Prefix string for trace messages.
static int	WARN_ID ID for warning messages.
static String	WARN_PREFIX Prefix string for warn messages.

Method Summary

void	init(RuntimeServices rs) Initializes this LogChute.
boolean	isLevelEnabled(int level) Tell whether or not a log level is enabled.
void	log(int level, String message) Send a log message from Velocity.
void	log(int level, String message, Throwable t) Send a log message from Velocity along with an exception or error

Field Detail

TRACE_PREFIX

static final String TRACE_PREFIX

Prefix string for trace messages.

See Also:

Constant Field Values

DEBUG_PREFIX

static final String DEBUG_PREFIX

Prefix string for debug messages.

See Also:

Constant Field Values

INFO_PREFIX

static final String INFO_PREFIX

Prefix string for info messages.

See Also:

Constant Field Values

WARN_PREFIX

static final String WARN_PREFIX

Prefix string for warn messages.

See Also:

Constant Field Values

ERROR_PREFIX

static final String ERROR_PREFIX

Prefix string for error messages.

See Also:

Constant Field Values

TRACE_ID

static final int TRACE_ID

ID for trace messages.

See Also:

Constant Field Values

DEBUG_ID

static final int DEBUG_ID

ID for debug messages.

See Also:

Constant Field Values

INFO_ID

static final int INFO_ID

ID for info messages.

See Also:

Constant Field Values

WARN_ID

static final int WARN_ID

ID for warning messages.

See Also:

Constant Field Values

ERROR_ID

static final int ERROR_ID

ID for error messages.

See Also:

Constant Field Values

Method Detail

init

void init(RuntimeServices rs)
          throws Exception

Initializes this LogChute.

Parameters:

rs -

Throws:

Exception

log

void log(int level,
         String message)

Send a log message from Velocity.

Parameters:

level -

message -

log

void log(int level,
         String message,
         Throwable t)

Send a log message from Velocity along with an exception or error

Parameters:

level -

message -

t -

isLevelEnabled

boolean isLevelEnabled(int level)

Tell whether or not a log level is enabled.

Parameters:

level -

Returns:

True if a level is enabled.