org.apache.logging.log4j.core.filter
Class CompositeFilter

java.lang.Object
  extended by org.apache.logging.log4j.core.filter.CompositeFilter
All Implemented Interfaces:
Iterable<Filter>, Filter, LifeCycle

public final class CompositeFilter
extends Object
implements Iterable<Filter>, Filter, LifeCycle

Composes and invokes one or more filters.


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.Filter
Filter.Result
 
Method Summary
 CompositeFilter addFilter(Filter filter)
           
static CompositeFilter createFilters(Filter[] filters)
          Create a CompositeFilter.
 Filter.Result filter(LogEvent event)
          Filter an event.
 Filter.Result filter(Logger logger, org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, org.apache.logging.log4j.message.Message msg, Throwable t)
          Filter an event.
 Filter.Result filter(Logger logger, org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, Object msg, Throwable t)
          Filter an event.
 Filter.Result filter(Logger logger, org.apache.logging.log4j.Level level, org.apache.logging.log4j.Marker marker, String msg, Object... params)
          Filter an event.
 List<Filter> getFilters()
           
 Filter.Result getOnMatch()
          Returns the result that should be returned when the filter matches the event.
 Filter.Result getOnMismatch()
          Returns the result that should be returned when the filter does not match the event.
 boolean hasFilters()
           
 boolean isStarted()
           
 Iterator<Filter> iterator()
           
 CompositeFilter removeFilter(Filter filter)
           
 int size()
           
 void start()
           
 void stop()
           
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

addFilter

public CompositeFilter addFilter(Filter filter)

removeFilter

public CompositeFilter removeFilter(Filter filter)

iterator

public Iterator<Filter> iterator()
Specified by:
iterator in interface Iterable<Filter>

getFilters

public List<Filter> getFilters()

hasFilters

public boolean hasFilters()

size

public int size()

start

public void start()
Specified by:
start in interface LifeCycle

stop

public void stop()
Specified by:
stop in interface LifeCycle

isStarted

public boolean isStarted()
Specified by:
isStarted in interface LifeCycle

getOnMismatch

public Filter.Result getOnMismatch()
Returns the result that should be returned when the filter does not match the event.

Specified by:
getOnMismatch in interface Filter
Returns:
the Result that should be returned when the filter does not match the event.

getOnMatch

public Filter.Result getOnMatch()
Returns the result that should be returned when the filter matches the event.

Specified by:
getOnMatch in interface Filter
Returns:
the Result that should be returned when the filter matches the event.

filter

public Filter.Result filter(Logger logger,
                            org.apache.logging.log4j.Level level,
                            org.apache.logging.log4j.Marker marker,
                            String msg,
                            Object... params)
Filter an event.

Specified by:
filter in interface Filter
Parameters:
logger - The Logger.
level - The event logging Level.
marker - The Marker for the event or null.
msg - String text to filter on.
params - An array of parameters or null.
Returns:
the Result.

filter

public Filter.Result filter(Logger logger,
                            org.apache.logging.log4j.Level level,
                            org.apache.logging.log4j.Marker marker,
                            Object msg,
                            Throwable t)
Filter an event.

Specified by:
filter in interface Filter
Parameters:
logger - The Logger.
level - The event logging Level.
marker - The Marker for the event or null.
msg - Any Object.
t - A Throwable or null.
Returns:
the Result.

filter

public Filter.Result filter(Logger logger,
                            org.apache.logging.log4j.Level level,
                            org.apache.logging.log4j.Marker marker,
                            org.apache.logging.log4j.message.Message msg,
                            Throwable t)
Filter an event.

Specified by:
filter in interface Filter
Parameters:
logger - The Logger.
level - The event logging Level.
marker - The Marker for the event or null.
msg - The Message
t - A Throwable or null.
Returns:
the Result.

filter

public Filter.Result filter(LogEvent event)
Filter an event.

Specified by:
filter in interface Filter
Parameters:
event - The Event to filter on.
Returns:
the Result.

toString

public String toString()
Overrides:
toString in class Object

createFilters

public static CompositeFilter createFilters(Filter[] filters)
Create a CompositeFilter.

Parameters:
filters - An array of Filters to call.
Returns:
The CompositeFilter.


Copyright © 1999-2012 Apache Software Foundation. All Rights Reserved. Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, and the Apache Logging project logo are trademarks of The Apache Software Foundation.