public class

ConsoleAppender

extends WriterAppender

java.lang.Object
↳	org.apache.log4j.AppenderSkeleton
	↳	org.apache.log4j.WriterAppender
		↳	org.apache.log4j.ConsoleAppender

Class Overview

ConsoleAppender appends log events to System.out or System.err using a layout specified by the user. The default target is System.out.

Summary

Constants
String	SYSTEM_ERR
String	SYSTEM_OUT

Fields
protected String	target

[Expand]

Inherited Fields

From class org.apache.log4j.WriterAppender

From class org.apache.log4j.AppenderSkeleton

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

Public Methods
void	activateOptions() Prepares the appender for use.
final 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.
final 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.

Protected Methods
final void	closeWriter() Close the underlying java.io.Writer.

[Expand]

Inherited Methods

From class org.apache.log4j.WriterAppender

void	activateOptions() Does nothing.
void	append(LoggingEvent event) This method is called by the `doAppend(LoggingEvent)` method.
boolean	checkEntryConditions() This method determines if there is a sense in attempting to append.
synchronized void	close() Close this appender instance.
void	closeWriter() Close the underlying java.io.Writer.
OutputStreamWriter	createWriter(OutputStream os) Returns an OutputStreamWriter when passed an OutputStream.
String	getEncoding()
boolean	getImmediateFlush() Returns value of the ImmediateFlush option.
boolean	requiresLayout() The WriterAppender requires a layout.
void	reset() Clear internal references to the writer and other variables.
void	setEncoding(String value)
synchronized void	setErrorHandler(ErrorHandler eh) Set the `ErrorHandler` for this WriterAppender and also the underlying `QuietWriter` if any.
void	setImmediateFlush(boolean value) If the ImmediateFlush option is set to `true`, the appender will flush at the end of each write.
synchronized void	setWriter(Writer writer) Sets the Writer where the log output will go.
boolean	shouldFlush(LoggingEvent event) Determines whether the writer should be flushed after this event is written.
void	subAppend(LoggingEvent event) Actual writing occurs here.
void	writeFooter() Write a footer as produced by the embedded layout's `getFooter()` method.
void	writeHeader() Write a header as produced by the embedded layout's `getHeader()` method.

From class org.apache.log4j.AppenderSkeleton

void	activateOptions() Derived appenders should override this method if option structure requires it.
void	addFilter(Filter newFilter) Add a filter to end of the filter list.
abstract void	append(LoggingEvent event) Subclasses of `AppenderSkeleton` should implement this method to perform actual logging.
void	clearFilters() Clear the filters chain.
synchronized void	doAppend(LoggingEvent event) This method performs threshold checks and invokes filters before delegating actual logging to the subclasses specific `append(LoggingEvent)` method.
void	finalize() Finalize this appender by calling the derived class' `close` method.
ErrorHandler	getErrorHandler() Return the currently set `ErrorHandler` for this Appender.
Filter	getFilter() Returns the head Filter.
final Filter	getFirstFilter() Return the first filter in the filter chain for this Appender.
Layout	getLayout() Returns the layout of this appender.
final String	getName() Returns the name of this appender.
Priority	getThreshold() Returns this appenders threshold level.
boolean	isAsSevereAsThreshold(Priority priority) Check whether the message level is below the appender's threshold.
synchronized void	setErrorHandler(ErrorHandler eh) Set the `ErrorHandler` for this Appender.
void	setLayout(Layout layout) Set the layout for this appender.
void	setName(String name) Set the name of this Appender.
void	setThreshold(Priority threshold) Set the threshold level.

From class java.lang.Object

From interface org.apache.log4j.Appender

abstract void	addFilter(Filter newFilter) Add a filter to the end of the filter list.
abstract void	clearFilters() Clear the list of filters by removing all the filters in it.
abstract void	close() Release any resources allocated within the appender such as file handles, network connections, etc.
abstract void	doAppend(LoggingEvent event) Log in `Appender` specific way.
abstract ErrorHandler	getErrorHandler() Returns the `ErrorHandler` for this appender.
abstract Filter	getFilter() Returns the head Filter.
abstract Layout	getLayout() Returns this appenders layout.
abstract String	getName() Get the name of this appender.
abstract boolean	requiresLayout() Configurators call this method to determine if the appender requires a layout.
abstract void	setErrorHandler(ErrorHandler errorHandler) Set the `ErrorHandler` for this appender.
abstract void	setLayout(Layout layout) Set the `Layout` for this appender.
abstract void	setName(String name) Set the name of this appender.

From interface org.apache.log4j.spi.OptionHandler

Constants

public static final String SYSTEM_ERR

Constant Value: "System.err"

public static final String SYSTEM_OUT

Constant Value: "System.out"

Fields

protected String target

Public Constructors

public ConsoleAppender ()

Constructs an unconfigured appender.

public ConsoleAppender (Layout layout)

Creates a configured appender.

Parameters

layout	layout, may not be null.

public ConsoleAppender (Layout layout, String target)

Creates a configured appender.

Parameters

layout	layout, may not be null.
target	target, either "System.err" or "System.out".

Public Methods

public void activateOptions ()

Prepares the appender for use.

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.

public String getTarget ()

Returns the current value of the Target property. The default value of the option is "System.out". See also setTarget(String).

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.

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.

Protected Methods

protected final void closeWriter ()

Close the underlying java.io.Writer.

Interfaces

Classes

ConsoleAppender

Class Overview

Summary

Constants

public static final String SYSTEM_ERR

public static final String SYSTEM_OUT

Fields

protected String target

Public Constructors

public ConsoleAppender ()

public ConsoleAppender (Layout layout)

Parameters

public ConsoleAppender (Layout layout, String target)

Parameters

Public Methods

public void activateOptions ()

public final boolean getFollow ()

Returns

public String getTarget ()

public final void setFollow (boolean newValue)

Parameters

public void setTarget (String value)

Protected Methods

protected final void closeWriter ()