log4cxx::rolling::RollingPolicyBase Class Reference

Implements methods common to most, it not all, rolling policies. More...

#include <rollingpolicybase.h>

Inheritance diagram for log4cxx::rolling::RollingPolicyBase:

Public Member Functions
	RollingPolicyBase ()
virtual	~RollingPolicyBase ()
void	activateOptions (helpers::Pool &p) override
	Activate the options that were previously set with calls to option setters.
virtual pattern::PatternMap	getFormatSpecifiers () const =0
	A map from a name to the object implementing the (date or index) formatting.
void	setOption (const LogString &option, const LogString &value) override
	Set option to value.
void	setFileNamePattern (const LogString &fnp)
	Set file name pattern.
LogString	getFileNamePattern () const
	Get file name pattern.
bool	getCreateIntermediateDirectories () const
void	setCreateIntermediateDirectories (bool createIntermediate)
PatternConverterList	getPatternConverterList () const
Public Member Functions inherited from log4cxx::rolling::RollingPolicy
virtual	~RollingPolicy ()
virtual RolloverDescriptionPtr	initialize (const LogString &currentActiveFile, const bool append, log4cxx::helpers::Pool &pool)=0
	Initialize the policy and return any initial actions for rolling file appender.
virtual RolloverDescriptionPtr	rollover (const LogString &currentActiveFile, const bool append, log4cxx::helpers::Pool &pool)=0
	Prepare for a rollover.
Public Member Functions inherited from log4cxx::spi::OptionHandler
virtual	~OptionHandler ()
virtual void	activateOptions (helpers::Pool &p)=0
	Activate the options that were previously set with calls to option setters.
virtual void	setOption (const LogString &option, const LogString &value)=0
	Set option to value.
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

Protected Member Functions
	RollingPolicyBase (LOG4CXX_PRIVATE_PTR(RollingPolicyBasePrivate) priv)
void	parseFileNamePattern ()
	Parse file name pattern.
void	formatFileName (const helpers::ObjectPtr &obj, LogString &buf, helpers::Pool &p) const
	Format file name.
log4cxx::pattern::PatternConverterPtr	getIntegerPatternConverter () const
log4cxx::pattern::PatternConverterPtr	getDatePatternConverter () const

Detailed Description

Implements methods common to most, it not all, rolling policies.

Constructor & Destructor Documentation

RollingPolicyBase() [1/2]

log4cxx::rolling::RollingPolicyBase::RollingPolicyBase

(

)

~RollingPolicyBase()

virtual log4cxx::rolling::RollingPolicyBase::~RollingPolicyBase ( )

virtual

RollingPolicyBase() [2/2]

log4cxx::rolling::RollingPolicyBase::RollingPolicyBase ( LOG4CXX_PRIVATE_PTR(RollingPolicyBasePrivate)  priv )

protected

Member Function Documentation

activateOptions()

void log4cxx::rolling::RollingPolicyBase::activateOptions ( helpers::Pool &  p )

overridevirtual

Activate the options that were previously set with calls to option setters.

Logs a warning if FileNamePattern is not set.

See also

RollingPolicy::activateOptions()

Implements log4cxx::spi::OptionHandler.

Reimplemented in log4cxx::rolling::TimeBasedRollingPolicy.

formatFileName()

void log4cxx::rolling::RollingPolicyBase::formatFileName ( const helpers::ObjectPtr &  obj, LogString &  buf, helpers::Pool &  p  ) const

protected

Format file name.

Parameters

obj	object to be evaluted in formatting, may not be null.
buf	string buffer to which formatted file name is appended, may not be null.
p	memory pool.

getCreateIntermediateDirectories()

bool log4cxx::rolling::RollingPolicyBase::getCreateIntermediateDirectories

(

)

const

getDatePatternConverter()

log4cxx::pattern::PatternConverterPtr log4cxx::rolling::RollingPolicyBase::getDatePatternConverter ( ) const

protected

getFileNamePattern()

LogString log4cxx::rolling::RollingPolicyBase::getFileNamePattern

(

)

const

Get file name pattern.

Returns

file name pattern.

getFormatSpecifiers()

virtual pattern::PatternMap log4cxx::rolling::RollingPolicyBase::getFormatSpecifiers ( ) const

pure virtual

A map from a name to the object implementing the (date or index) formatting.

Implemented in log4cxx::rolling::FixedWindowRollingPolicy, and log4cxx::rolling::TimeBasedRollingPolicy.

getIntegerPatternConverter()

log4cxx::pattern::PatternConverterPtr log4cxx::rolling::RollingPolicyBase::getIntegerPatternConverter ( ) const

protected

getPatternConverterList()

PatternConverterList log4cxx::rolling::RollingPolicyBase::getPatternConverterList

(

)

const

parseFileNamePattern()

void log4cxx::rolling::RollingPolicyBase::parseFileNamePattern ( )

protected

Parse file name pattern.

setCreateIntermediateDirectories()

void log4cxx::rolling::RollingPolicyBase::setCreateIntermediateDirectories

(

bool

createIntermediate

)

setFileNamePattern()

void log4cxx::rolling::RollingPolicyBase::setFileNamePattern

(

const LogString &

fnp

)

Set file name pattern.

Parameters

fnp	file name pattern.

setOption()

void log4cxx::rolling::RollingPolicyBase::setOption ( const LogString &  option, const LogString &  value  )

overridevirtual

Set option to value.

Supported options	Supported values	Default value
FileNamePattern	(^)	-
CreateIntermediateDirectories	True,False	False

(^) Legal file name characters plus any conversion specifier supported by the concrete class.

See also

getFormatSpecifiers()

Implements log4cxx::spi::OptionHandler.

Reimplemented in log4cxx::rolling::TimeBasedRollingPolicy.

---

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

• rollingpolicybase.h