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, LocationAware, 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	Description
static class	WriterAppender.Builder<B extends WriterAppender.Builder<B>>	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 LifeCycle

LifeCycle.State

Field Summary

Fields

Modifier and Type	Field	Description
private static WriterAppender.WriterManagerFactory	factory

Fields inherited from class AbstractWriterAppender

immediateFlush

Fields inherited from class AbstractLifeCycle

DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGER

Fields inherited from interface Appender

ELEMENT_TYPE, EMPTY_ARRAY

Constructor Summary

Constructors

Modifier	Constructor	Description
private	WriterAppender(String name, StringLayout layout, Filter filter, WriterManager manager, boolean ignoreExceptions, Property[] properties)

Method Summary

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

Methods inherited from class AbstractWriterAppender

append, getManager, getStringLayout, start, stop

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, stop

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

factory

private static WriterAppender.WriterManagerFactory factory

Constructor Details

WriterAppender

private WriterAppender(String name,
 StringLayout layout,
 Filter filter,
 WriterManager manager,
 boolean ignoreExceptions,
 Property[] properties)

Method Details

createAppender

@PluginFactory
public static WriterAppender createAppender(StringLayout layout,
 Filter filter,
 Writer target,
 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

name - The name of the Appender (required).

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

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(Writer target,
 boolean follow,
 StringLayout layout)

newBuilder

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