org.apache.log4j

Class ConsoleAppender

java.lang.Object

org.apache.log4j.AppenderSkeleton

org.apache.log4j.WriterAppender

org.apache.log4j.ConsoleAppender

All Implemented Interfaces:

Appender, OptionHandler

public class ConsoleAppender
extends WriterAppender

Placeholder for Log4j 1.2 Console Appender.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.log4j.AppenderSkeleton

AppenderSkeleton.NoOpErrorHandler

Field Summary

Fields

Modifier and Type	Field and Description
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

Constructors

Constructor and Description
ConsoleAppender() Constructs a non-configured appender.
ConsoleAppender(Layout layout) Constructs a configured appender.
ConsoleAppender(Layout layout, String target) Constructs a configured appender.

Method Summary

Modifier and Type	Method and Description
void	append(LoggingEvent theEvent) This method is called by the AppenderSkeleton.doAppend(org.apache.log4j.spi.LoggingEvent) method.
void	close() Close this appender instance.
boolean	getFollow() Gets whether the appender honors reassignments of System.out or System.err made after configuration.
String	getTarget() Gets the current value of the Target property.
boolean	requiresLayout() The WriterAppender requires a layout.
void	setFollow(boolean follow) 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, checkEntryConditions, closeWriter, createWriter, getEncoding, getImmediateFlush, reset, setEncoding, setErrorHandler, setImmediateFlush, setWriter, shouldFlush, subAppend, writeFooter, writeHeader

Methods inherited from class org.apache.log4j.AppenderSkeleton

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

Methods inherited from class java.lang.Object

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

Field Detail

SYSTEM_OUT

public static final String SYSTEM_OUT

See Also:

Constant Field Values

SYSTEM_ERR

public static final String SYSTEM_ERR

See Also:

Constant Field Values

target

protected String target

Constructor Detail

ConsoleAppender

public ConsoleAppender()

Constructs a non-configured appender.

ConsoleAppender

public ConsoleAppender(Layout layout)

Constructs a configured appender.

Parameters:

layout - layout, may not be null.

ConsoleAppender

public ConsoleAppender(Layout layout,
                       String target)

Constructs a configured appender.

Parameters:

layout - layout, may not be null.

target - target, either "System.err" or "System.out".

Method Detail

append

public void append(LoggingEvent theEvent)

This method is called by the AppenderSkeleton.doAppend(org.apache.log4j.spi.LoggingEvent) method.

If the output stream exists and is writable then write a log statement to the output stream. Otherwise, write a single warning message to System.err.

The format of the output will depend on this appender's layout.

Overrides:

append in class WriterAppender

close

public void close()

Close this appender instance. The underlying stream or writer is also closed.

Closed appenders cannot be reused.

Specified by:

close in interface Appender

Overrides:

close in class WriterAppender

See Also:

WriterAppender.setWriter(java.io.Writer)

getFollow

public 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()

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

requiresLayout

public boolean requiresLayout()

The WriterAppender requires a layout. Hence, this method returns true.

Specified by:

requiresLayout in interface Appender

Overrides:

requiresLayout in class WriterAppender

Returns:

true if a Layout is required.

setFollow

public void setFollow(boolean follow)

Sets whether the appender honors reassignments of System.out or System.err made after configuration.

Parameters:

follow - 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.