org.apache.logging.log4j.core.appender

Class WriterAppender

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.AbstractWriterAppender<WriterManager>

org.apache.logging.log4j.core.appender.WriterAppender

All Implemented Interfaces:

Appender, Filterable, LifeCycle, LifeCycle2

@Plugin(name="Writer",
        category="Core",
        elementType="appender",
        printObject=true)
public final class WriterAppender
extends AbstractWriterAppender<WriterManager>

Appends log events to a Writer.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WriterAppender.Builder Builds WriterAppender instances.
private static class	WriterAppender.FactoryData Holds data to pass to factory method.
private static class	WriterAppender.WriterManagerFactory

Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.LifeCycle

LifeCycle.State

Field Summary

Fields

Modifier and Type	Field and Description
private static WriterAppender.WriterManagerFactory	factory

Fields inherited from class org.apache.logging.log4j.core.appender.AbstractWriterAppender

immediateFlush

Fields inherited from class org.apache.logging.log4j.core.AbstractLifeCycle

DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGER

Fields inherited from interface org.apache.logging.log4j.core.Appender

ELEMENT_TYPE

Constructor Summary

Constructors

Modifier	Constructor and Description
private	WriterAppender(java.lang.String name, StringLayout layout, Filter filter, WriterManager manager, boolean ignoreExceptions)

Method Summary

Modifier and Type	Method and Description
static WriterAppender	createAppender(StringLayout layout, Filter filter, java.io.Writer target, java.lang.String name, boolean follow, boolean ignore) Creates a WriterAppender.
private static WriterManager	getManager(java.io.Writer target, boolean follow, StringLayout layout)
static WriterAppender.Builder	newBuilder()

Methods inherited from class org.apache.logging.log4j.core.appender.AbstractWriterAppender

append, getManager, getStringLayout, start, stop

Methods inherited from class org.apache.logging.log4j.core.appender.AbstractAppender

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

Methods inherited from class org.apache.logging.log4j.core.filter.AbstractFilterable

addFilter, getFilter, hasFilter, isFiltered, removeFilter, stop

Methods inherited from class org.apache.logging.log4j.core.AbstractLifeCycle

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.logging.log4j.core.LifeCycle

getState, initialize, isStarted, isStopped, stop

Field Detail

factory

private static WriterAppender.WriterManagerFactory factory

Constructor Detail

WriterAppender

private WriterAppender(java.lang.String name,
                       StringLayout layout,
                       Filter filter,
                       WriterManager manager,
                       boolean ignoreExceptions)

Method Detail

createAppender

@PluginFactory
public static WriterAppender createAppender(StringLayout layout,
                                                           Filter filter,
                                                           java.io.Writer target,
                                                           java.lang.String name,
                                                           boolean follow,
                                                           boolean ignore)

Creates a WriterAppender.

Parameters:

layout - The layout to use or null to get the default layout.

filter - The Filter or null.

target - The target Writer

follow - If true will follow changes to the underlying output stream. Use false as the default.

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. Use true as the default.

Returns:

The ConsoleAppender.

getManager

private static WriterManager getManager(java.io.Writer target,
                                        boolean follow,
                                        StringLayout layout)

newBuilder

@PluginBuilderFactory
public static WriterAppender.Builder newBuilder()