Defines the minimum set of levels recognized by the system, that is OFF, FATAL, ERROR, WARN, INFO, DEBUG and ALL. More...

#include <level.h>

Inheritance diagram for log4cxx::Level:

Classes
struct	Data
class	LevelClass

Public Types
enum	{ OFF_INT = INT_MAX , FATAL_INT = 50000 , ERROR_INT = 40000 , WARN_INT = 30000 , INFO_INT = 20000 , DEBUG_INT = 10000 , TRACE_INT = 5000 , ALL_INT = INT_MIN }
using	DataPtr = std::shared_ptr<Data>

Public Member Functions
	Level (int level, const LogString &name, int syslogEquivalent)
	Instantiate a Level object.
void	toString (std::string &name) const
	Get the name of the level in the current encoding.
void	toString (std::wstring &name) const
	Get the name of the level.
void	toString (std::basic_string< UniChar > &name) const
	Get the name of the level.
void	toString (CFStringRef &name) const
	Get the name of the level.
LogString	toString () const
	Returns the string representation of this level.
virtual bool	equals (const LevelPtr &level) const
	Two levels are equal if their level fields are equal.
bool	operator== (const Level &level1) const
bool	operator!= (const Level &level1) const
int	getSyslogEquivalent () const
	Return the syslog equivalent of this level as an integer.
virtual bool	isGreaterOrEqual (const LevelPtr &level) const
	Returns `true` if this level has a higher or equal level than the level passed as argument, `false` otherwise.
int	toInt () const
	Returns the integer representation of this level.
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

Static Public Member Functions
static LevelPtr	toLevel (const std::string &sArg)
	Convert the string passed as argument to a level.
static LevelPtr	toLevel (const std::string &sArg, const LevelPtr &defaultLevel)
	Convert the string passed as argument to a level.
static LevelPtr	toLevel (const std::wstring &sArg)
	Convert the string passed as argument to a level.
static LevelPtr	toLevel (const std::wstring &sArg, const LevelPtr &defaultLevel)
	Convert the string passed as argument to a level.
static LevelPtr	toLevel (const std::basic_string< UniChar > &sArg)
	Convert the string passed as argument to a level.
static LevelPtr	toLevel (const std::basic_string< UniChar > &sArg, const LevelPtr &defaultLevel)
	Convert the string passed as argument to a level.
static LevelPtr	toLevel (const CFStringRef &sArg)
	Convert the string passed as argument to a level.
static LevelPtr	toLevel (const CFStringRef &sArg, const LevelPtr &defaultLevel)
	Convert the string passed as argument to a level.
static LevelPtr	toLevelLS (const LogString &sArg)
	Convert the string passed as argument to a level.
static LevelPtr	toLevelLS (const LogString &sArg, const LevelPtr &defaultLevel)
	Convert the string passed as argument to a level.
static LevelPtr	toLevel (int val)
	Convert an integer passed as argument to a level.
static LevelPtr	toLevel (int val, const LevelPtr &defaultLevel)
	Convert an integer passed as argument to a level.
static const DataPtr &	getData ()
static LevelPtr	getAll ()
static LevelPtr	getFatal ()
static LevelPtr	getError ()
static LevelPtr	getWarn ()
static LevelPtr	getInfo ()
static LevelPtr	getDebug ()
static LevelPtr	getTrace ()
static LevelPtr	getOff ()

Detailed Description

Defines the minimum set of levels recognized by the system, that is OFF, FATAL, ERROR, WARN, INFO, DEBUG and ALL.

The Level class may be subclassed to define a larger level set.

Member Typedef Documentation

◆ DataPtr

using log4cxx::Level::DataPtr = std::shared_ptr<Data>

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
OFF_INT
FATAL_INT
ERROR_INT
WARN_INT
INFO_INT
DEBUG_INT
TRACE_INT
ALL_INT

Constructor & Destructor Documentation

◆ Level()

log4cxx::Level::Level	(	int	level,
		const LogString &	name,
		int	syslogEquivalent )

Instantiate a Level object.

Member Function Documentation

◆ equals()

virtual bool log4cxx::Level::equals ( const LevelPtr & level ) const

virtual

Two levels are equal if their level fields are equal.

◆ getAll()

LevelPtr log4cxx::Level::getAll ( )

static

◆ getData()

const DataPtr & log4cxx::Level::getData ( )

static

◆ getDebug()

LevelPtr log4cxx::Level::getDebug ( )

static

◆ getError()

LevelPtr log4cxx::Level::getError ( )

static

◆ getFatal()

LevelPtr log4cxx::Level::getFatal ( )

static

◆ getInfo()

LevelPtr log4cxx::Level::getInfo ( )

static

◆ getOff()

LevelPtr log4cxx::Level::getOff ( )

static

◆ getSyslogEquivalent()

int log4cxx::Level::getSyslogEquivalent ( ) const

inline

Return the syslog equivalent of this level as an integer.

◆ getTrace()

LevelPtr log4cxx::Level::getTrace ( )

static

◆ getWarn()

LevelPtr log4cxx::Level::getWarn ( )

static

◆ isGreaterOrEqual()

virtual bool log4cxx::Level::isGreaterOrEqual ( const LevelPtr & level ) const

virtual

Returns true if this level has a higher or equal level than the level passed as argument, false otherwise.

You should think twice before overriding the default implementation of isGreaterOrEqual method.

◆ operator!=()

bool log4cxx::Level::operator!= ( const Level & level1 ) const

inline

◆ operator==()

bool log4cxx::Level::operator== ( const Level & level1 ) const

inline

◆ toInt()

int log4cxx::Level::toInt ( ) const

inline

Returns the integer representation of this level.

◆ toLevel() [1/10]

LevelPtr log4cxx::Level::toLevel ( const CFStringRef & sArg )

static

Convert the string passed as argument to a level.

If the conversion fails, then this method returns DEBUG.

Parameters

sArg	level name.

◆ toLevel() [2/10]

LevelPtr log4cxx::Level::toLevel	(	const CFStringRef &	sArg,
		const LevelPtr &	defaultLevel )

static

Convert the string passed as argument to a level.

If the conversion fails, then this method returns the value of defaultLevel.

Parameters

sArg	level name.
defaultLevel	level to return if no match.

Returns

◆ toLevel() [3/10]

LevelPtr log4cxx::Level::toLevel ( const std::basic_string< UniChar > & sArg )

static

Convert the string passed as argument to a level.

If the conversion fails, then this method returns DEBUG.

Parameters

sArg	level name.

◆ toLevel() [4/10]

LevelPtr log4cxx::Level::toLevel	(	const std::basic_string< UniChar > &	sArg,
		const LevelPtr &	defaultLevel )

static

Convert the string passed as argument to a level.

If the conversion fails, then this method returns the value of defaultLevel.

Parameters

sArg	level name.
defaultLevel	level to return if no match.

Returns

◆ toLevel() [5/10]

LevelPtr log4cxx::Level::toLevel ( const std::string & sArg )

static

Convert the string passed as argument to a level.

If the conversion fails, then this method returns DEBUG.

Parameters

sArg	level name.

◆ toLevel() [6/10]

LevelPtr log4cxx::Level::toLevel	(	const std::string &	sArg,
		const LevelPtr &	defaultLevel )

static

Convert the string passed as argument to a level.

If the conversion fails, then this method returns the value of defaultLevel.

Parameters

sArg	level name.
defaultLevel	level to return if no match.

Returns

◆ toLevel() [7/10]

LevelPtr log4cxx::Level::toLevel ( const std::wstring & sArg )

static

Convert the string passed as argument to a level.

If the conversion fails, then this method returns DEBUG.

Parameters

sArg	level name.

◆ toLevel() [8/10]

LevelPtr log4cxx::Level::toLevel	(	const std::wstring &	sArg,
		const LevelPtr &	defaultLevel )

static

Convert the string passed as argument to a level.

If the conversion fails, then this method returns the value of defaultLevel.

Parameters

sArg	level name.
defaultLevel	level to return if no match.

Returns

◆ toLevel() [9/10]

LevelPtr log4cxx::Level::toLevel ( int val )

static

Convert an integer passed as argument to a level.

If the conversion fails, then this method returns DEBUG.

◆ toLevel() [10/10]

LevelPtr log4cxx::Level::toLevel	(	int	val,
		const LevelPtr &	defaultLevel )

static

Convert an integer passed as argument to a level.

If the conversion fails, then this method returns the specified default.

◆ toLevelLS() [1/2]

LevelPtr log4cxx::Level::toLevelLS ( const LogString & sArg )

static

Convert the string passed as argument to a level.

If the conversion fails, then this method returns DEBUG.

Parameters

sArg	level name.

◆ toLevelLS() [2/2]

LevelPtr log4cxx::Level::toLevelLS	(	const LogString &	sArg,
		const LevelPtr &	defaultLevel )

static

Convert the string passed as argument to a level.

If the conversion fails, then this method returns the value of defaultLevel.

Parameters

sArg	level name.
defaultLevel	level to return if no match.

Returns

◆ toString() [1/5]

LogString log4cxx::Level::toString ( ) const

Returns the string representation of this level.

Returns: level name.

◆ toString() [2/5]

void log4cxx::Level::toString ( CFStringRef & name ) const

Get the name of the level.

Parameters

name	buffer to which name is appended.

◆ toString() [3/5]

void log4cxx::Level::toString ( std::basic_string< UniChar > & name ) const

Get the name of the level.

Parameters

name	buffer to which name is appended.

◆ toString() [4/5]

void log4cxx::Level::toString ( std::string & name ) const

Get the name of the level in the current encoding.

Parameters

name	buffer to which name is appended.

◆ toString() [5/5]

void log4cxx::Level::toString ( std::wstring & name ) const

Get the name of the level.

Parameters

name	buffer to which name is appended.

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

level.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ DataPtr

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ Level()

Member Function Documentation

◆ equals()

◆ getAll()

◆ getData()

◆ getDebug()

◆ getError()

◆ getFatal()

◆ getInfo()

◆ getOff()

◆ getSyslogEquivalent()

◆ getTrace()

◆ getWarn()

◆ isGreaterOrEqual()

◆ operator!=()

◆ operator==()

◆ toInt()

◆ toLevel() [1/10]

◆ toLevel() [2/10]

◆ toLevel() [3/10]

◆ toLevel() [4/10]

◆ toLevel() [5/10]

◆ toLevel() [6/10]

◆ toLevel() [7/10]

◆ toLevel() [8/10]

◆ toLevel() [9/10]

◆ toLevel() [10/10]

◆ toLevelLS() [1/2]

◆ toLevelLS() [2/2]

◆ toString() [1/5]

◆ toString() [2/5]

◆ toString() [3/5]

◆ toString() [4/5]

◆ toString() [5/5]