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
ConsoleAppender appends log events to
System.out or
System.err using a layout specified by the user. The default
target is System.out.- Since:
- 1.1
- Author:
- Ceki Gülcü, Curt Arnold
-
Field Summary
FieldsFields inherited from class org.apache.log4j.WriterAppender
encoding, immediateFlush, qwFields inherited from class org.apache.log4j.AppenderSkeleton
closed, errorHandler, headFilter, layout, name, tailFilter, threshold -
Constructor Summary
ConstructorsConstructorDescriptionConstructs an unconfigured appender.ConsoleAppender(Layout layout) Creates a configured appender.ConsoleAppender(Layout layout, String target) Creates a configured appender. -
Method Summary
Modifier and TypeMethodDescriptionvoidPrepares the appender for use.protected final voidClose the underlyingWriter.final booleanGets whether the appender honors reassignments of System.out or System.err made after configuration.Returns the current value of the Target property.final voidsetFollow(boolean newValue) Sets whether the appender honors reassignments of System.out or System.err made after configuration.voidSets the value of the Target option.Methods inherited from class org.apache.log4j.WriterAppender
append, checkEntryConditions, close, createWriter, getEncoding, getImmediateFlush, requiresLayout, reset, setEncoding, setErrorHandler, setImmediateFlush, setWriter, shouldFlush, subAppend, writeFooter, writeHeaderMethods 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
-
-
Constructor Details
-
ConsoleAppender
public ConsoleAppender()Constructs an unconfigured appender. -
ConsoleAppender
Creates a configured appender.- Parameters:
layout- layout, may not be null.
-
ConsoleAppender
Creates a configured appender.- Parameters:
layout- layout, may not be null.target- target, either "System.err" or "System.out".
-
-
Method Details
-
setTarget
Sets the value of the Target option. Recognized values are "System.out" and "System.err". Any other value will be ignored. -
getTarget
Returns the current value of the Target property. The default value of the option is "System.out".See also
setTarget(java.lang.String). -
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
-
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
-
activateOptions
public void activateOptions()Prepares the appender for use.- Specified by:
activateOptionsin interfaceOptionHandler- Overrides:
activateOptionsin classWriterAppender
-
closeWriter
protected final void closeWriter()Close the underlyingWriter.- Overrides:
closeWriterin classWriterAppender
-