org.apache.logging.log4j.core.appender
Class ConsoleAppender
java.lang.Object
org.apache.logging.log4j.core.AbstractLifeCycle
org.apache.logging.log4j.core.filter.AbstractFilterable
org.apache.logging.log4j.core.appender.AbstractAppender
org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender<OutputStreamManager>
org.apache.logging.log4j.core.appender.ConsoleAppender
- All Implemented Interfaces:
- Appender, Filterable, LifeCycle
@Plugin(name="Console",
category="Core",
elementType="appender",
printObject=true)
public final class ConsoleAppender
- extends AbstractOutputStreamAppender<OutputStreamManager>
ConsoleAppender appends log events to System.out
or
System.err
using a layout specified by the user. The
default target is System.out
.
- Troublesome:
- accessing System.out or .err as a byte stream instead of a writer
bypasses the JVM's knowledge of the proper encoding. (RG) Encoding
is handled within the Layout. Typically, a Layout will generate a String
and then call getBytes which may use a configured encoding or the system
default. OTOH, a Writer cannot print byte streams.
Methods inherited from class org.apache.logging.log4j.core.AbstractLifeCycle |
getState, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping |
createAppender
@PluginFactory
public static ConsoleAppender createAppender(@PluginElement(value="Layout")
Layout<? extends Serializable> layout,
@PluginElement(value="Filter")
Filter filter,
@PluginAttribute(value="target",defaultString="SYSTEM_OUT")
String targetStr,
@PluginAttribute(value="name")
String name,
@PluginAttribute(value="follow",defaultBoolean=false)
String follow,
@PluginAttribute(value="ignoreExceptions",defaultBoolean=true)
String ignore)
- Create a Console Appender.
- Parameters:
layout
- The layout to use (required).filter
- The Filter or null.targetStr
- The target ("SYSTEM_OUT" or "SYSTEM_ERR"). The default is "SYSTEM_OUT".follow
- If true will follow changes to the underlying output stream.name
- The name of the Appender (required).ignore
- If "true"
(default) exceptions encountered when appending events are logged; otherwise
they are propagated to the caller.
- Returns:
- The ConsoleAppender.
Copyright © 1999-2014 Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.