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
Placeholder for Log4j 1.2 Console Appender.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.log4j.AppenderSkeleton
AppenderSkeleton.NoOpErrorHandler
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
Determines if the appender honors reassignments of System.out or System.err made after configuration.static final String
static final String
protected String
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
ConstructorsConstructorDescriptionConstructs a non-configured appender.ConsoleAppender
(Layout layout) Constructs a configured appender.ConsoleAppender
(Layout layout, String target) Constructs a configured appender. -
Method Summary
Modifier and TypeMethodDescriptionvoid
append
(LoggingEvent theEvent) This method is called by theAppenderSkeleton.doAppend(org.apache.log4j.spi.LoggingEvent)
method.void
close()
Close this appender instance.boolean
Gets whether the appender honors reassignments of System.out or System.err made after configuration.Gets the current value of the Target property.boolean
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
Sets the value of the Target option.(package private) void
targetWarn
(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 Details
-
SYSTEM_OUT
- See Also:
-
SYSTEM_ERR
- See Also:
-
target
-
follow
private boolean followDetermines if the appender honors reassignments of System.out or System.err made after configuration.
-
-
Constructor Details
-
ConsoleAppender
public ConsoleAppender()Constructs a non-configured appender. -
ConsoleAppender
Constructs a configured appender.- Parameters:
layout
- layout, may not be null.
-
ConsoleAppender
Constructs a configured appender.- Parameters:
layout
- layout, may not be null.target
- target, either "System.err" or "System.out".
-
-
Method Details
-
append
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:
-
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
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
Sets the value of the Target option. Recognized values are "System.out" and "System.err". Any other value will be ignored. -
targetWarn
-