org.apache.velocity.runtime.log
Class SystemLogChute

java.lang.Object
  extended by org.apache.velocity.runtime.log.SystemLogChute
All Implemented Interfaces:
LogChute

public class SystemLogChute
extends Object
implements LogChute

Logger used when no other is configured. By default, all messages will be printed to the System.err output stream.

Since:
1.5
Version:
$Id: SystemLogChute.java 718424 2008-11-17 22:50:43Z nbubna $
Author:
Nathan Bubna

Field Summary
static String RUNTIME_LOG_LEVEL_KEY
           
static String RUNTIME_LOG_SYSTEM_ERR_LEVEL_KEY
           
 
Fields inherited from interface org.apache.velocity.runtime.log.LogChute
DEBUG_ID, DEBUG_PREFIX, ERROR_ID, ERROR_PREFIX, INFO_ID, INFO_PREFIX, TRACE_ID, TRACE_PREFIX, WARN_ID, WARN_PREFIX
 
Constructor Summary
SystemLogChute()
           
 
Method Summary
 int getEnabledLevel()
          Returns the current minimum level at which messages will be printed.
protected  String getPrefix(int level)
           
 int getSystemErrLevel()
          Returns the current minimum level at which messages will be printed to System.err instead of System.out.
 void init(RuntimeServices rs)
          Initializes this LogChute.
 boolean isLevelEnabled(int level)
          This will return true if the specified level is equal to or higher than the level this LogChute is enabled for.
 void log(int level, String message)
          Logs messages to either std.out or std.err depending on their severity.
 void log(int level, String message, Throwable t)
          Logs messages to the system console so long as the specified level is equal to or greater than the level this LogChute is enabled for.
 void setEnabledLevel(int level)
          Set the minimum level at which messages will be printed.
 void setSystemErrLevel(int level)
          Set the minimum level at which messages will be printed to System.err instead of System.out.
protected  int toLevel(String level)
           
protected  void write(PrintStream stream, String prefix, String message, Throwable t)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

RUNTIME_LOG_LEVEL_KEY

public static final String RUNTIME_LOG_LEVEL_KEY
See Also:
Constant Field Values

RUNTIME_LOG_SYSTEM_ERR_LEVEL_KEY

public static final String RUNTIME_LOG_SYSTEM_ERR_LEVEL_KEY
See Also:
Constant Field Values
Constructor Detail

SystemLogChute

public SystemLogChute()
Method Detail

init

public void init(RuntimeServices rs)
          throws Exception
Description copied from interface: LogChute
Initializes this LogChute.

Specified by:
init in interface LogChute
Throws:
Exception

toLevel

protected int toLevel(String level)

getPrefix

protected String getPrefix(int level)

log

public void log(int level,
                String message)
Logs messages to either std.out or std.err depending on their severity.

Specified by:
log in interface LogChute
Parameters:
level - severity level
message - complete error message

log

public void log(int level,
                String message,
                Throwable t)
Logs messages to the system console so long as the specified level is equal to or greater than the level this LogChute is enabled for. If the level is equal to or greater than LogChute.ERROR_ID, messages will be printed to System.err. Otherwise, they will be printed to System.out. If a java.lang.Throwable accompanies the message, it's stack trace will be printed to the same stream as the message.

Specified by:
log in interface LogChute
Parameters:
level - severity level
message - complete error message
t - the java.lang.Throwable

write

protected void write(PrintStream stream,
                     String prefix,
                     String message,
                     Throwable t)

setEnabledLevel

public void setEnabledLevel(int level)
Set the minimum level at which messages will be printed.


getEnabledLevel

public int getEnabledLevel()
Returns the current minimum level at which messages will be printed.


setSystemErrLevel

public void setSystemErrLevel(int level)
Set the minimum level at which messages will be printed to System.err instead of System.out.


getSystemErrLevel

public int getSystemErrLevel()
Returns the current minimum level at which messages will be printed to System.err instead of System.out.


isLevelEnabled

public boolean isLevelEnabled(int level)
This will return true if the specified level is equal to or higher than the level this LogChute is enabled for.

Specified by:
isLevelEnabled in interface LogChute
Returns:
True if a level is enabled.


Copyright © 2000-2008 The Apache Software Foundation. All Rights Reserved.