org.apache.logging.log4j.core.filter

Class AbstractFilterable

java.lang.Object

org.apache.logging.log4j.core.AbstractLifeCycle

org.apache.logging.log4j.core.filter.AbstractFilterable

All Implemented Interfaces:

Filterable, LifeCycle, LifeCycle2

Direct Known Subclasses:

AbstractAppender, AbstractConfiguration, AppenderControl, LoggerConfig

public abstract class AbstractFilterable
extends AbstractLifeCycle
implements Filterable

Enhances a Class by allowing it to contain Filters.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractFilterable.Builder<B extends AbstractFilterable.Builder<B>> Subclasses can extend this abstract Builder.

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.AbstractLifeCycle

DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFilterable()
protected	AbstractFilterable(Filter filter)
protected	AbstractFilterable(Filter filter, Property[] propertyArray)

Method Summary

Modifier and Type	Method and Description
void	addFilter(Filter filter) Adds a filter.
Filter	getFilter() Returns the Filter.
Property[]	getPropertyArray()
boolean	hasFilter() Determines if a Filter is present.
boolean	isFiltered(LogEvent event) Determine if the LogEvent should be processed or ignored.
void	removeFilter(Filter filter) Removes a Filter.
void	start() Make the Filter available for use.
boolean	stop(long timeout, TimeUnit timeUnit) Cleanup the Filter.
protected boolean	stop(long timeout, TimeUnit timeUnit, boolean changeLifeCycleState) Cleanup the Filter.

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, toString, wait, wait, wait

Methods inherited from interface org.apache.logging.log4j.core.LifeCycle

getState, initialize, isStarted, isStopped, stop

Constructor Detail

AbstractFilterable

protected AbstractFilterable()

AbstractFilterable

protected AbstractFilterable(Filter filter)

AbstractFilterable

protected AbstractFilterable(Filter filter,
                             Property[] propertyArray)

Since:

2.11.2

Method Detail

addFilter

public void addFilter(Filter filter)

Adds a filter.

Specified by:

addFilter in interface Filterable

Parameters:

filter - The Filter to add.

getFilter

public Filter getFilter()

Returns the Filter.

Specified by:

getFilter in interface Filterable

Returns:

the Filter or null.

hasFilter

public boolean hasFilter()

Determines if a Filter is present.

Specified by:

hasFilter in interface Filterable

Returns:

false if no Filter is present.

isFiltered

public boolean isFiltered(LogEvent event)

Determine if the LogEvent should be processed or ignored.

Specified by:

isFiltered in interface Filterable

Parameters:

event - The LogEvent.

Returns:

true if the LogEvent should be processed.

removeFilter

public void removeFilter(Filter filter)

Removes a Filter.

Specified by:

removeFilter in interface Filterable

Parameters:

filter - The Filter to remove.

start

public void start()

Make the Filter available for use.

Specified by:

start in interface LifeCycle

Overrides:

start in class AbstractLifeCycle

stop

public boolean stop(long timeout,
                    TimeUnit timeUnit)

Cleanup the Filter.

Specified by:

stop in interface LifeCycle2

Overrides:

stop in class AbstractLifeCycle

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.

stop

protected boolean stop(long timeout,
                       TimeUnit timeUnit,
                       boolean changeLifeCycleState)

Cleanup the Filter.

getPropertyArray

public Property[] getPropertyArray()