Package 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 Description private boolean
follow
Determines if the appender honors reassignments of System.out or System.err made after configuration.static java.lang.String
SYSTEM_ERR
static java.lang.String
SYSTEM_OUT
protected java.lang.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 Description ConsoleAppender()
Constructs a non-configured appender.ConsoleAppender(Layout layout)
Constructs a configured appender.ConsoleAppender(Layout layout, java.lang.String target)
Constructs a configured appender.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
append(LoggingEvent theEvent)
This method is called by theAppenderSkeleton.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.java.lang.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(java.lang.String value)
Sets the value of the Target option.(package private) void
targetWarn(java.lang.String val)
-
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
-
-
-
-
Field Detail
-
SYSTEM_OUT
public static final java.lang.String SYSTEM_OUT
- See Also:
- Constant Field Values
-
SYSTEM_ERR
public static final java.lang.String SYSTEM_ERR
- See Also:
- Constant Field Values
-
target
protected java.lang.String target
-
follow
private boolean follow
Determines if the appender honors reassignments of System.out or System.err made after configuration.
-
-
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, java.lang.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 theAppenderSkeleton.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 classWriterAppender
-
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 interfaceAppender
- Overrides:
close
in classWriterAppender
- 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 java.lang.String getTarget()
Gets the current value of the Target property. The default value of the option is "System.out". See alsosetTarget(java.lang.String)
.
-
requiresLayout
public boolean requiresLayout()
The WriterAppender requires a layout. Hence, this method returnstrue
.- Specified by:
requiresLayout
in interfaceAppender
- Overrides:
requiresLayout
in classWriterAppender
- 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(java.lang.String value)
Sets the value of the Target option. Recognized values are "System.out" and "System.err". Any other value will be ignored.
-
targetWarn
void targetWarn(java.lang.String val)
-
-