log4cxx::rolling::Action Class Reference

A file system action performed as part of a rollover event. More...

#include <action.h>

Inheritance diagram for log4cxx::rolling::Action:

Public Member Functions
bool	execute () const
	Perform the action.
virtual bool	execute (helpers::Pool &pool) const =0
void	run ()
void	close ()
bool	isComplete () const
	Is action is complete?
LogString	getName () const
void	reportException (const std::exception &)
void	run (helpers::Pool &pool)
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
	Action ()
	Constructor.
	Action (LOG4CXX_PRIVATE_PTR(ActionPrivate) priv)
virtual	~Action ()

Detailed Description

A file system action performed as part of a rollover event.

Constructor & Destructor Documentation

Action() [1/2]

log4cxx::rolling::Action::Action ( )

protected

Constructor.

Action() [2/2]

log4cxx::rolling::Action::Action ( LOG4CXX_PRIVATE_PTR(ActionPrivate) priv )

protected

~Action()

virtual log4cxx::rolling::Action::~Action ( )

protectedvirtual

Member Function Documentation

close()

void log4cxx::rolling::Action::close

(

)

execute() [1/2]

bool log4cxx::rolling::Action::execute

(

)

const

Perform the action.

Returns

true if successful.

execute() [2/2]

virtual bool log4cxx::rolling::Action::execute ( helpers::Pool & pool ) const

pure virtual

Deprecated

The pool parameter is not used and will be removed in a future version. Implement this method for now, but plan to migrate to execute() without a helpers::Pool parameter.

Implemented in log4cxx::rolling::FileRenameAction, log4cxx::rolling::GZCompressAction, and log4cxx::rolling::ZipCompressAction.

getName()

LogString log4cxx::rolling::Action::getName

(

)

const

isComplete()

bool log4cxx::rolling::Action::isComplete

(

)

const

Is action is complete?

reportException()

void log4cxx::rolling::Action::reportException

(

const std::exception &

)

run() [1/2]

void log4cxx::rolling::Action::run

(

)

run() [2/2]

void log4cxx::rolling::Action::run

(

helpers::Pool &

pool

)

---

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

• action.h