Apache log4cxx  Version 0.12.0
log4cxx::spi::LocationInfo Class Reference

This class represents the location of a logging statement. More...

#include <locationinfo.h>

Public Member Functions

 LocationInfo (const char *const fileName, const char *const functionName, int lineNumber)
 Constructor. More...
 
 LocationInfo ()
 Default constructor. More...
 
 LocationInfo (const LocationInfo &src)
 Copy constructor. More...
 
LocationInfooperator= (const LocationInfo &src)
 Assignment operator. More...
 
void clear ()
 Resets location info to default state. More...
 
const std::string getClassName () const
 Return the class name of the call site. More...
 
const char * getFileName () const
 Return the file name of the caller. More...
 
int getLineNumber () const
 Returns the line number of the caller. More...
 
const std::string getMethodName () const
 Returns the method name of the caller. More...
 
void write (log4cxx::helpers::ObjectOutputStream &os, log4cxx::helpers::Pool &p) const
 

Static Public Member Functions

static const LocationInfogetLocationUnavailable ()
 

Static Public Attributes

static const char *const NA
 When location information is not available the constant NA is returned. More...
 
static const char *const NA_METHOD
 

Detailed Description

This class represents the location of a logging statement.

Constructor & Destructor Documentation

◆ LocationInfo() [1/3]

log4cxx::spi::LocationInfo::LocationInfo ( const char *const  fileName,
const char *const  functionName,
int  lineNumber 
)

Constructor.

Remarks
Used by LOG4CXX_LOCATION to generate location info for current code site

◆ LocationInfo() [2/3]

log4cxx::spi::LocationInfo::LocationInfo ( )

Default constructor.

◆ LocationInfo() [3/3]

log4cxx::spi::LocationInfo::LocationInfo ( const LocationInfo src)

Copy constructor.

Parameters
srcsource location

Member Function Documentation

◆ clear()

void log4cxx::spi::LocationInfo::clear ( )

Resets location info to default state.

◆ getClassName()

const std::string log4cxx::spi::LocationInfo::getClassName ( ) const

Return the class name of the call site.

◆ getFileName()

const char* log4cxx::spi::LocationInfo::getFileName ( ) const

Return the file name of the caller.

Returns
file name, may be null.

◆ getLineNumber()

int log4cxx::spi::LocationInfo::getLineNumber ( ) const

Returns the line number of the caller.

Returns
line number, -1 if not available.

◆ getLocationUnavailable()

static const LocationInfo& log4cxx::spi::LocationInfo::getLocationUnavailable ( )
static

◆ getMethodName()

const std::string log4cxx::spi::LocationInfo::getMethodName ( ) const

Returns the method name of the caller.

◆ operator=()

LocationInfo& log4cxx::spi::LocationInfo::operator= ( const LocationInfo src)

Assignment operator.

Parameters
srcsource location

◆ write()

void log4cxx::spi::LocationInfo::write ( log4cxx::helpers::ObjectOutputStream os,
log4cxx::helpers::Pool p 
) const

Member Data Documentation

◆ NA

const char* const log4cxx::spi::LocationInfo::NA
static

When location information is not available the constant NA is returned.

Current value of this string constant is ?.

◆ NA_METHOD

const char* const log4cxx::spi::LocationInfo::NA_METHOD
static

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