Apache log4cxx (Incubating)  Version 0.10.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups
FilterBasedTriggeringPolicy Class Reference

FilterBasedTriggeringPolicy determines if rolling should be triggered by evaluating the current message against a set of filters. More...

Inheritance diagram for FilterBasedTriggeringPolicy:
TriggeringPolicy OptionHandler ObjectImpl Object Object

Public Member Functions

 FilterBasedTriggeringPolicy ()
 Creates a new FilterBasedTriggeringPolicy. More...
 
virtual ~FilterBasedTriggeringPolicy ()
 
virtual bool isTriggeringEvent (Appender *appender, const log4cxx::spi::LoggingEventPtr &event, const LogString &filename, size_t fileLength)
 Determines if a rollover may be appropriate at this time. More...
 
void addFilter (const log4cxx::spi::FilterPtr &newFilter)
 Add a filter to end of the filter list. More...
 
void clearFilters ()
 Clear the filters chain. More...
 
log4cxx::spi::FilterPtrgetFilter ()
 Returns the head Filter. More...
 
void activateOptions (log4cxx::helpers::Pool &)
 Prepares the instance for use. More...
 
void setOption (const LogString &option, const LogString &value)
 Set option to value. More...
 
- Public Member Functions inherited from TriggeringPolicy
virtual ~TriggeringPolicy ()
 
void addRef () const
 
void releaseRef () const
 
- Public Member Functions inherited from OptionHandler
virtual ~OptionHandler ()
 
- Public Member Functions inherited from Object
virtual const helpers::ClassgetClass () const
 
virtual ~Object ()
 
virtual bool instanceof (const Class &clazz) const =0
 
virtual const void * cast (const Class &clazz) const =0
 
- Public Member Functions inherited from ObjectImpl
 ObjectImpl ()
 
virtual ~ObjectImpl ()
 

Additional Inherited Members

- Static Public Member Functions inherited from Object
static const helpers::ClassgetStaticClass ()
 
static const
log4cxx::helpers::ClassRegistration
registerClass ()
 
- Protected Attributes inherited from ObjectImpl
unsigned int volatile ref
 

Detailed Description

FilterBasedTriggeringPolicy determines if rolling should be triggered by evaluating the current message against a set of filters.

Unless a filter rejects a message, a rolling event will be triggered.

Constructor & Destructor Documentation

virtual ~FilterBasedTriggeringPolicy ( )
virtual

Member Function Documentation

void activateOptions ( log4cxx::helpers::Pool )
virtual

Prepares the instance for use.

Implements OptionHandler.

void addFilter ( const log4cxx::spi::FilterPtr newFilter)

Add a filter to end of the filter list.

Parameters
newFilterfilter to add to end of list.
void clearFilters ( )

Clear the filters chain.

log4cxx::spi::FilterPtr& getFilter ( )

Returns the head Filter.

virtual bool isTriggeringEvent ( Appender appender,
const log4cxx::spi::LoggingEventPtr event,
const LogString filename,
size_t  fileLength 
)
virtual

Determines if a rollover may be appropriate at this time.

If true is returned, RolloverPolicy.rollover will be called but it can determine that a rollover is not warranted.

Parameters
appenderA reference to the appender.
eventA reference to the currently event.
filenameThe filename for the currently active log file.
fileLengthLength of the file in bytes.
Returns
true if a rollover should occur.

Implements TriggeringPolicy.

void setOption ( const LogString option,
const LogString value 
)
virtual

Set option to value.

The handling of each option depends on the OptionHandler instance. Some options may become active immediately whereas other may be activated only when activateOptions is called.

Implements OptionHandler.


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