Apache log4cxx  Version 0.12.1
log4cxx::filter::LoggerMatchFilter Class Reference

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

#include <loggermatchfilter.h>

Inheritance diagram for log4cxx::filter::LoggerMatchFilter:
log4cxx::spi::Filter log4cxx::spi::OptionHandler log4cxx::helpers::Object log4cxx::helpers::Object

Public Types

typedef spi::Filter BASE_CLASS
- Public Types inherited from log4cxx::spi::Filter
enum  FilterDecision { DENY = -1, NEUTRAL = 0, ACCEPT = 1 }

Public Member Functions

 LoggerMatchFilter ()
virtual void setOption (const LogString &option, const LogString &value)
 Set options. More...
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. More...
- Public Member Functions inherited from log4cxx::spi::Filter
 Filter ()
log4cxx::spi::FilterPtr getNext () const
void setNext (const log4cxx::spi::FilterPtr &newNext)
void activateOptions (log4cxx::helpers::Pool &p)
 Usually filters options become active when set. More...
void setOption (const LogString &option, const LogString &value)
 Set option to value. More...
- Public Member Functions inherited from log4cxx::spi::OptionHandler
virtual ~OptionHandler ()
- Public Member Functions inherited from log4cxx::helpers::Object
virtual ~Object ()
virtual bool instanceof (const Class &clazz) const =0
virtual const void * cast (const Class &clazz) const =0

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#DENY is returned. If there is no match, spi::Filter#NEUTRAL is returned. A loggerToMatch of "root" matches both the root logger and a logger named "root".

Member Typedef Documentation


Constructor & Destructor Documentation

◆ LoggerMatchFilter()

log4cxx::filter::LoggerMatchFilter::LoggerMatchFilter ( )

Member Function Documentation

◆ decide()

FilterDecision log4cxx::filter::LoggerMatchFilter::decide ( const spi::LoggingEventPtr event) const

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 log4cxx::spi::Filter.

◆ getAcceptOnMatch()

bool log4cxx::filter::LoggerMatchFilter::getAcceptOnMatch ( ) const

◆ getLoggerToMatch()

LogString log4cxx::filter::LoggerMatchFilter::getLoggerToMatch ( ) const

◆ setAcceptOnMatch()

void log4cxx::filter::LoggerMatchFilter::setAcceptOnMatch ( bool  acceptOnMatch1)

◆ setLoggerToMatch()

void log4cxx::filter::LoggerMatchFilter::setLoggerToMatch ( const LogString levelToMatch)

◆ setOption()

virtual void log4cxx::filter::LoggerMatchFilter::setOption ( const LogString option,
const LogString value 

Set options.

Implements log4cxx::spi::OptionHandler.

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