This is a very simple filter based on level matching. More...
#include <levelmatchfilter.h>
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 | |
| LevelMatchFilter () | |
| ~LevelMatchFilter () | |
| void | setOption (const LogString &option, const LogString &value) override |
Set option to value. | |
| void | setLevelToMatch (const LogString &levelToMatch) |
| LogString | getLevelToMatch () const |
| void | setAcceptOnMatch (bool acceptOnMatch1) |
| bool | getAcceptOnMatch () const |
| FilterDecision | decide (const spi::LoggingEventPtr &event) const override |
| Return the decision of this filter. | |
| Public Member Functions inherited from log4cxx::spi::Filter | |
| Filter () | |
| Filter (std::unique_ptr< FilterPrivate > priv) | |
| virtual | ~Filter () |
| log4cxx::spi::FilterPtr | getNext () const |
| void | setNext (const log4cxx::spi::FilterPtr &newNext) |
| void | activateOptions (helpers::Pool &p) override |
| Activate the options that were previously set with calls to option setters. | |
| Public Member Functions inherited from log4cxx::spi::OptionHandler | |
| virtual | ~OptionHandler () |
| Public Member Functions inherited from log4cxx::helpers::Object | |
| virtual | ~Object () |
| virtual const helpers::Class & | getClass () const =0 |
| 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 level matching.
The filter admits two options levelToMatch and acceptOnMatch. If there is an exact match between the value of the levelToMatch option and the level of the LoggingEvent, then the decide method returns ACCEPT in case the acceptOnMatch option value is set to true, if it is false then DENY is returned. If there is no match, NEUTRAL is returned.
Member Typedef Documentation
◆ BASE_CLASS
Constructor & Destructor Documentation
◆ LevelMatchFilter()
| log4cxx::filter::LevelMatchFilter::LevelMatchFilter | ( | ) |
◆ ~LevelMatchFilter()
| log4cxx::filter::LevelMatchFilter::~LevelMatchFilter | ( | ) |
Member Function Documentation
◆ decide()
|
overridevirtual |
Return the decision of this filter.
Returns NEUTRAL if the levelToMatch 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::LevelMatchFilter::getAcceptOnMatch | ( | ) | const |
◆ getLevelToMatch()
| LogString log4cxx::filter::LevelMatchFilter::getLevelToMatch | ( | ) | const |
◆ setAcceptOnMatch()
| void log4cxx::filter::LevelMatchFilter::setAcceptOnMatch | ( | bool | acceptOnMatch1 | ) |
◆ setLevelToMatch()
| void log4cxx::filter::LevelMatchFilter::setLevelToMatch | ( | const LogString & | levelToMatch | ) |
◆ setOption()
|
overridevirtual |
Set option to value.
| Supported options | Supported values | Default value |
|---|---|---|
| LevelToMatch | (1) | - |
| AcceptOnMatch | True,False | True |
(1) One of Trace, Debug, Info, Warn, Error, Fatal, Off, All or a custom level in which case it is of the form {levelName}#{registeredClassName}.
Reimplemented from log4cxx::spi::Filter.
The documentation for this class was generated from the following file:
