@Plugin(name="Console", category="Core", elementType="appender", printObject=true) public final class ConsoleAppender extends AbstractOutputStreamAppender<OutputStreamManager>
System.out
or System.err
using a layout specified by the user. The
default target is System.out
.
TODO 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.
Modifier and Type | Class and Description |
---|---|
static class |
ConsoleAppender.Builder
Builds ConsoleAppender instances.
|
static class |
ConsoleAppender.Target
Enumeration of console destinations.
|
LifeCycle.State
LOGGER
ELEMENT_TYPE
Modifier and Type | Method and Description |
---|---|
static ConsoleAppender |
createAppender(Layout<? extends Serializable> layout,
Filter filter,
ConsoleAppender.Target target,
String name,
boolean follow,
boolean ignoreExceptions)
Creates a Console Appender.
|
static ConsoleAppender |
createAppender(Layout<? extends Serializable> layout,
Filter filter,
String targetStr,
String name,
String follow,
String ignore)
Deprecated.
|
static ConsoleAppender |
createDefaultAppenderForLayout(Layout<? extends Serializable> layout) |
ConsoleAppender.Target |
getTarget() |
static ConsoleAppender.Builder |
newBuilder() |
append, directEncodeEvent, getImmediateFlush, getManager, start, stop, writeByteArrayToManager
error, error, error, getHandler, getLayout, getName, ignoreExceptions, parseInt, setHandler, toString
addFilter, getFilter, hasFilter, isFiltered, removeFilter
equalsImpl, getState, hashCodeImpl, initialize, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getState, initialize, isStarted, isStopped
@Deprecated public static ConsoleAppender createAppender(Layout<? extends Serializable> layout, Filter filter, String targetStr, String name, String follow, String ignore)
createAppender(Layout, Filter, Target, String, boolean, boolean)
.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.@PluginFactory public static ConsoleAppender createAppender(@PluginElement(value="Layout") Layout<? extends Serializable> layout, @PluginElement(value="Filter") Filter filter, @PluginAttribute(value="target") ConsoleAppender.Target target, @PluginAttribute(value="name") String name, @PluginAttribute(value="follow",defaultBoolean=false) boolean follow, @PluginAttribute(value="ignoreExceptions",defaultBoolean=true) boolean ignoreExceptions)
layout
- The layout to use (required).filter
- The Filter or null.target
- 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).ignoreExceptions
- If "true"
(default) exceptions encountered when appending events are logged; otherwise they
are propagated to the caller.public static ConsoleAppender createDefaultAppenderForLayout(Layout<? extends Serializable> layout)
@PluginBuilderFactory public static ConsoleAppender.Builder newBuilder()
public ConsoleAppender.Target getTarget()
Copyright © 1999-2016 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.