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, LocationAware, LifeCycle, LifeCycle2

@Plugin(name="Console",
        category="Core",
        elementType="appender",
        printObject=true)
public final class ConsoleAppender
extends AbstractOutputStreamAppender<OutputStreamManager>

Appends log events to System.out or System.err using a layout specified by the user. The default target is System.out.

TODO Accessing System.out or System.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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConsoleAppender.Builder<B extends ConsoleAppender.Builder<B>>	Builds ConsoleAppender instances.
static enum	ConsoleAppender.Target	Enumeration of console destinations.

Nested classes/interfaces inherited from interface LifeCycle

LifeCycle.State

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PLUGIN_NAME

Fields inherited from class AbstractLifeCycle

DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGER

Fields inherited from interface Appender

ELEMENT_TYPE, EMPTY_ARRAY

Method Summary

Modifier and Type	Method	Description
static ConsoleAppender	createAppender(Layout<? extends Serializable> layout, Filter filter, String targetStr, String name, String follow, String ignore)	Deprecated. Deprecated in 2.7; use newBuilder().
static ConsoleAppender	createAppender(Layout<? extends Serializable> layout, Filter filter, ConsoleAppender.Target target, String name, boolean follow, boolean direct, boolean ignoreExceptions)	Deprecated. Deprecated in 2.7; use newBuilder().
static ConsoleAppender	createDefaultAppenderForLayout(Layout<? extends Serializable> layout)
ConsoleAppender.Target	getTarget()
static <B extends ConsoleAppender.Builder<B>> B	newBuilder()

Methods inherited from class AbstractOutputStreamAppender

append, directEncodeEvent, getImmediateFlush, getManager, start, stop, stop, writeByteArrayToManager

Methods inherited from class AbstractAppender

error, error, error, getHandler, getLayout, getName, ignoreExceptions, parseInt, requiresLocation, setHandler, toSerializable, toString

Methods inherited from class AbstractFilterable

addFilter, getFilter, getPropertyArray, hasFilter, isFiltered, removeFilter

Methods inherited from class AbstractLifeCycle

equalsImpl, getState, getStatusLogger, hashCodeImpl, initialize, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping, stop, stop

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface LifeCycle

getState, initialize, isStarted, isStopped, stop

Field Details

PLUGIN_NAME

public static final String PLUGIN_NAME

See Also:

• Constant Field Values

Method Details

createAppender

@Deprecated
public static ConsoleAppender createAppender(Layout<? extends Serializable> layout,
 Filter filter,
 String targetStr,
 String name,
 String follow,
 String ignore)

Deprecated.

Deprecated in 2.7; use newBuilder().

Creates 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".

name - The name of the Appender (required).

follow - If true will follow changes to the underlying output stream.

ignore - If "true" (default) exceptions encountered when appending events are logged; otherwise they are propagated to the caller.

Returns:

The ConsoleAppender.

createAppender

@Deprecated
public static ConsoleAppender createAppender(Layout<? extends Serializable> layout,
 Filter filter,
 ConsoleAppender.Target target,
 String name,
 boolean follow,
 boolean direct,
 boolean ignoreExceptions)

Deprecated.

Deprecated in 2.7; use newBuilder().

Creates a Console Appender.

Parameters:

layout - The layout to use (required).

filter - The Filter or null.

target - The target (SYSTEM_OUT or SYSTEM_ERR). The default is SYSTEM_OUT.

name - The name of the Appender (required).

follow - If true will follow changes to the underlying output stream.

direct - If true will write directly to FileDescriptor and bypass System.out/System.err.

ignoreExceptions - If "true" (default) exceptions encountered when appending events are logged; otherwise they are propagated to the caller.

Returns:

The ConsoleAppender.

createDefaultAppenderForLayout

public static ConsoleAppender createDefaultAppenderForLayout(Layout<? extends Serializable> layout)

newBuilder

@PluginBuilderFactory
public static <B extends ConsoleAppender.Builder<B>>
B newBuilder()

getTarget

public ConsoleAppender.Target getTarget()