org.apache.log4j

Class ConsoleAppender

Implemented Interfaces:
Appender, OptionHandler

public class ConsoleAppender
extends WriterAppender

ConsoleAppender appends log events to System.out or System.err using a layout specified by the user. The default target is System.out.
Authors:
Ceki Gülcü
Curt Arnold
Since:
1.1

Field Summary

static String
SYSTEM_ERR
static String
SYSTEM_OUT
protected String
target

Fields inherited from class org.apache.log4j.WriterAppender

encoding, immediateFlush, qw

Fields inherited from class org.apache.log4j.AppenderSkeleton

closed, errorHandler, headFilter, layout, name, tailFilter, threshold

Constructor Summary

ConsoleAppender()
Constructs an unconfigured appender.
ConsoleAppender(Layout layout)
Creates a configured appender.
ConsoleAppender(Layout layout, String target)
Creates a configured appender.

Method Summary

void
activateOptions()
Prepares the appender for use.
protected void
closeWriter()
boolean
getFollow()
Gets whether the appender honors reassignments of System.out or System.err made after configuration.
String
getTarget()
Returns the current value of the Target property.
void
setFollow(boolean newValue)
Sets whether the appender honors reassignments of System.out or System.err made after configuration.
void
setTarget(String value)
Sets the value of the Target option.

Methods inherited from class org.apache.log4j.WriterAppender

activateOptions, append, checkEntryConditions, close, closeWriter, createWriter, getEncoding, getImmediateFlush, requiresLayout, reset, setEncoding, setErrorHandler, setImmediateFlush, setWriter, subAppend, writeFooter, writeHeader

Methods inherited from class org.apache.log4j.AppenderSkeleton

activateOptions, addFilter, append, clearFilters, doAppend, finalize, getErrorHandler, getFilter, getFirstFilter, getLayout, getName, getThreshold, isAsSevereAsThreshold, setErrorHandler, setLayout, setName, setThreshold

Field Details

SYSTEM_ERR

public static final String SYSTEM_ERR

SYSTEM_OUT

public static final String SYSTEM_OUT

target

protected String target

Constructor Details

ConsoleAppender

public ConsoleAppender()
Constructs an unconfigured appender.

ConsoleAppender

public ConsoleAppender(Layout layout)
Creates a configured appender.
Parameters:
layout - layout, may not be null.

ConsoleAppender

public ConsoleAppender(Layout layout,
                       String target)
Creates a configured appender.
Parameters:
layout - layout, may not be null.

Method Details

activateOptions

public void activateOptions()
Prepares the appender for use.
Specified by:
activateOptions in interface OptionHandler
Overrides:
activateOptions in interface WriterAppender

closeWriter

protected final void closeWriter()
Overrides:
closeWriter in interface WriterAppender

getFollow

public final boolean getFollow()
Gets whether the appender honors reassignments of System.out or System.err made after configuration.
Returns:
true if appender will use value of System.out or System.err in force at the time when logging events are appended.
Since:
1.2.13

getTarget

public String getTarget()

setFollow

public final void setFollow(boolean newValue)
Sets whether the appender honors reassignments of System.out or System.err made after configuration.
Parameters:
newValue - if true, appender will use value of System.out or System.err in force at the time when logging events are appended.
Since:
1.2.13

setTarget

public void setTarget(String value)
Sets the value of the Target option. Recognized values are "System.out" and "System.err". Any other value will be ignored.

Copyright 2000-2005 Apache Software Foundation.