org.apache.logging.log4j.core.appender

Class AbstractFileAppender<M extends OutputStreamManager>

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<M>

org.apache.logging.log4j.core.appender.AbstractFileAppender<M>

All Implemented Interfaces:

Appender, Filterable, LocationAware, LifeCycle, LifeCycle2

public abstract class AbstractFileAppender<M extends OutputStreamManager>
extends AbstractOutputStreamAppender<M>

Abstract File Appender.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractFileAppender.Builder<B extends AbstractFileAppender.Builder<B>> Builds FileAppender instances.

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

LifeCycle.State

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Object	advertisement
private Advertiser	advertiser
private java.lang.String	fileName

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	AbstractFileAppender(java.lang.String name, Layout<? extends java.io.Serializable> layout, Filter filter, M manager, java.lang.String filename, boolean ignoreExceptions, boolean immediateFlush, Advertiser advertiser, Property[] properties)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFileName() Returns the file name this appender is associated with.
boolean	stop(long timeout, java.util.concurrent.TimeUnit timeUnit) Cleanup the Filter.

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

append, directEncodeEvent, getImmediateFlush, getManager, start, 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

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

fileName

private final java.lang.String fileName

advertiser

private final Advertiser advertiser

advertisement

private final java.lang.Object advertisement

Constructor Detail

AbstractFileAppender

private AbstractFileAppender(java.lang.String name,
                             Layout<? extends java.io.Serializable> layout,
                             Filter filter,
                             M manager,
                             java.lang.String filename,
                             boolean ignoreExceptions,
                             boolean immediateFlush,
                             Advertiser advertiser,
                             Property[] properties)

Method Detail

getFileName

public java.lang.String getFileName()

Returns the file name this appender is associated with.

Returns:

The File name.

stop

public boolean stop(long timeout,
                    java.util.concurrent.TimeUnit timeUnit)

Description copied from class: AbstractFilterable

Cleanup the Filter.

Specified by:

stop in interface LifeCycle2

Overrides:

stop in class AbstractOutputStreamAppender<M extends OutputStreamManager>

Parameters:

timeout - the maximum time to wait

timeUnit - the time unit of the timeout argument

Returns:

true if the receiver was stopped cleanly and normally, false otherwise.