Class OutputStreamAppender
- 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.OutputStreamAppender
-
- All Implemented Interfaces:
Appender
,Filterable
,LocationAware
,LifeCycle
,LifeCycle2
@Plugin(name="OutputStream", category="Core", elementType="appender", printObject=true) public final class OutputStreamAppender extends AbstractOutputStreamAppender<OutputStreamManager>
Appends log events to a given output stream using a layout.Character encoding is handled within the Layout.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
OutputStreamAppender.Builder<B extends OutputStreamAppender.Builder<B>>
Builds OutputStreamAppender instances.private static class
OutputStreamAppender.FactoryData
Holds data to pass to factory method.private static class
OutputStreamAppender.OutputStreamManagerFactory
Creates the manager.-
Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.LifeCycle
LifeCycle.State
-
-
Field Summary
Fields Modifier and Type Field Description private static OutputStreamAppender.OutputStreamManagerFactory
factory
-
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 Description private
OutputStreamAppender(java.lang.String name, Layout<? extends java.io.Serializable> layout, Filter filter, OutputStreamManager manager, boolean ignoreExceptions, Property[] properties)
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static OutputStreamAppender
createAppender(Layout<? extends java.io.Serializable> layout, Filter filter, java.io.OutputStream target, java.lang.String name, boolean follow, boolean ignore)
Creates an OutputStream Appender.private static OutputStreamManager
getManager(java.io.OutputStream target, boolean follow, Layout<? extends java.io.Serializable> layout)
static <B extends OutputStreamAppender.Builder<B>>
BnewBuilder()
-
Methods inherited from class org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender
append, directEncodeEvent, getImmediateFlush, getManager, start, stop, stop, writeByteArrayToManager
-
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
-
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
-
-
-
-
Field Detail
-
factory
private static OutputStreamAppender.OutputStreamManagerFactory factory
-
-
Constructor Detail
-
OutputStreamAppender
private OutputStreamAppender(java.lang.String name, Layout<? extends java.io.Serializable> layout, Filter filter, OutputStreamManager manager, boolean ignoreExceptions, Property[] properties)
-
-
Method Detail
-
createAppender
@PluginFactory public static OutputStreamAppender createAppender(Layout<? extends java.io.Serializable> layout, Filter filter, java.io.OutputStream target, java.lang.String name, boolean follow, boolean ignore)
Creates an OutputStream Appender.- Parameters:
layout
- The layout to use or null to get the default layout.filter
- The Filter or null.target
- an output stream.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 OutputStreamManager getManager(java.io.OutputStream target, boolean follow, Layout<? extends java.io.Serializable> layout)
-
newBuilder
@PluginBuilderFactory public static <B extends OutputStreamAppender.Builder<B>> B newBuilder()
-
-