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	Description
static class	AbstractFileAppender.Builder<B extends AbstractFileAppender.Builder<B>>	Builds FileAppender instances.

Nested classes/interfaces inherited from interface LifeCycle

LifeCycle.State

Field Summary

Fields

Modifier and Type	Field	Description
private final Object	advertisement
private final Advertiser	advertiser
private final String	fileName

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

Method Summary

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

Methods inherited from class AbstractOutputStreamAppender

append, directEncodeEvent, getImmediateFlush, getManager, start, stop, writeByteArrayToManager

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

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

fileName

private final String fileName

advertiser

private final Advertiser advertiser

advertisement

private final Object advertisement

Constructor Details

AbstractFileAppender

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

Method Details

getFileName

public String getFileName()

Returns the file name this appender is associated with.

Returns:

The File name.

stop

public boolean stop(long timeout,
 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.