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 aWriter
.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
WriterAppender.Builder<B extends WriterAppender.Builder<B>>
Builds WriterAppender instances.-
Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.LifeCycle
LifeCycle.State
-
-
Field Summary
-
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
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static WriterAppender
createAppender(StringLayout layout, Filter filter, Writer target, String name, boolean follow, boolean ignore)
Creates a WriterAppender.static <B extends WriterAppender.Builder<B>>
BnewBuilder()
-
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, requiresLocation, setHandler, toSerializable, toString
-
Methods inherited from class org.apache.logging.log4j.core.filter.AbstractFilterable
addFilter, getFilter, getPropertyArray, 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
-
-
-
-
Method Detail
-
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 Writerfollow
- 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.
-
newBuilder
@PluginBuilderFactory public static <B extends WriterAppender.Builder<B>> B newBuilder()
-
-