Apache log4cxx  Version 0.10.1
LoggerMatchFilter Class Reference

This is a very simple filter based on logger name matching. More...

Inherits Filter.

List of all members.

Public Types

typedef spi::Filter BASE_CLASS

Public Member Functions

 LoggerMatchFilter ()
virtual void setOption (const LogString &option, const LogString &value)
 Set options.
void setLoggerToMatch (const LogString &levelToMatch)
LogString getLoggerToMatch () const
void setAcceptOnMatch (bool acceptOnMatch1)
bool getAcceptOnMatch () const
FilterDecision decide (const spi::LoggingEventPtr &event) const
 Return the decision of this filter.

Detailed Description

This is a very simple filter based on logger name matching.

The filter admits two options LoggerToMatch and AcceptOnMatch. If there is an exact match between the value of the LoggerToMatch option and the logger of the LoggingEvent, then the decide method returns ACCEPT in case the AcceptOnMatch option value is set to true, if it is false then spi::filter::Filter#DENY is returned. If there is no match, spi::filter::Filter#NEUTRAL is returned. A loggerToMatch of "root" matches both the root logger and a logger named "root".


Member Typedef Documentation


Constructor & Destructor Documentation


Member Function Documentation

FilterDecision decide ( const spi::LoggingEventPtr event) const [virtual]

Return the decision of this filter.

Returns NEUTRAL if the LoggerToMatch option is not set or if there is not match. Otherwise, if there is a match, then the returned decision is ACCEPT if the AcceptOnMatch property is set to true. The returned decision is DENY if the AcceptOnMatch property is set to false.

Implements Filter.

bool getAcceptOnMatch ( ) const [inline]
LogString getLoggerToMatch ( ) const
void setAcceptOnMatch ( bool  acceptOnMatch1) [inline]
void setLoggerToMatch ( const LogString levelToMatch)
virtual void setOption ( const LogString option,
const LogString value 
) [virtual]

Set options.

Reimplemented from Filter.


The documentation for this class was generated from the following file: