decaf::util::logging::LogRecord Class Reference

LogRecord objects are used to pass logging requests between the logging framework and individual log Handlers. More...

#include <src/main/decaf/util/logging/LogRecord.h>

Public Member Functions
	LogRecord ()
virtual	~LogRecord ()
Level	getLevel () const
	Get Level of this log record.
void	setLevel (Level value)
	Set the Level of this Log Record.
const std::string &	getLoggerName () const
	Gets the Source Logger's Name.
void	setLoggerName (const std::string &loggerName)
	Sets the Source Logger's Name.
const std::string &	getSourceFile () const
	Gets the Source Log File name.
void	setSourceFile (const std::string &sourceFile)
	Sets the Source Log File Name.
unsigned int	getSourceLine () const
	Gets the Source Log line number.
void	setSourceLine (unsigned int sourceLine)
	Sets the Source Log line number.
const std::string &	getMessage () const
	Gets the Message to be Logged.
void	setMessage (const std::string &message)
	Sets the Message to be Logged.
const std::string &	getSourceFunction () const
	Gets the name of the function where this log was logged.
void	setSourceFunction (const std::string &functionName)
	Sets the name of the function where this log was logged.
long long	getTimestamp () const
	Gets the time in mills that this message was logged.
void	setTimestamp (long long timeStamp)
	Sets the time in mills that this message was logged.
long long	getTreadId () const
	Gets the Thread Id where this Log was created.
void	setTreadId (long long threadId)
	Sets the Thread Id where this Log was created.
decaf::lang::Throwable *	getThrown () const
	Gets any Throwable associated with this LogRecord.
void	setThrown (decaf::lang::Throwable *thrown)
	Sets the Throwable associated with this LogRecord, the pointer becomes the property of this instance of the LogRecord and will be deleted when the record is destroyed.

---

Detailed Description

LogRecord objects are used to pass logging requests between the logging framework and individual log Handlers.

When a LogRecord is passed into the logging framework it logically belongs to the framework and should no longer be used or updated by the client application.

Since:

1.0

---

Constructor & Destructor Documentation

decaf::util::logging::LogRecord::LogRecord

(

)

virtual decaf::util::logging::LogRecord::~LogRecord

(

)

[virtual]

---

Member Function Documentation

Level decaf::util::logging::LogRecord::getLevel

(

)

const [inline]

Get Level of this log record.

Returns:

Level enumeration value.

const std::string& decaf::util::logging::LogRecord::getLoggerName

(

)

const [inline]

Gets the Source Logger's Name.

Returns:

the source loggers name

const std::string& decaf::util::logging::LogRecord::getMessage

(

)

const [inline]

Gets the Message to be Logged.

Returns:

the source logger's message

const std::string& decaf::util::logging::LogRecord::getSourceFile

(

)

const [inline]

Gets the Source Log File name.

Returns:

the source loggers name

const std::string& decaf::util::logging::LogRecord::getSourceFunction

(

)

const [inline]

Gets the name of the function where this log was logged.

Returns:

the source logger's message

unsigned int decaf::util::logging::LogRecord::getSourceLine

(

)

const [inline]

Gets the Source Log line number.

Returns:

the source loggers line number

decaf::lang::Throwable* decaf::util::logging::LogRecord::getThrown

(

)

const [inline]

Gets any Throwable associated with this LogRecord.

Returns:

point to a Throwable instance or Null.

long long decaf::util::logging::LogRecord::getTimestamp

(

)

const [inline]

Gets the time in mills that this message was logged.

Returns:

UTC time in milliseconds

long long decaf::util::logging::LogRecord::getTreadId

(

)

const [inline]

Gets the Thread Id where this Log was created.

Returns:

the source loggers line number

void decaf::util::logging::LogRecord::setLevel

(

Level

value

)

[inline]

Set the Level of this Log Record.

Parameters:

value

Level Enumeration Value

void decaf::util::logging::LogRecord::setLoggerName

(

const std::string &

loggerName

)

[inline]

Sets the Source Logger's Name.

Parameters:

loggerName

the source loggers name

void decaf::util::logging::LogRecord::setMessage

(

const std::string &

message

)

[inline]

Sets the Message to be Logged.

Parameters:

message

the source loggers message

void decaf::util::logging::LogRecord::setSourceFile

(

const std::string &

sourceFile

)

[inline]

Sets the Source Log File Name.

Parameters:

sourceFile

the source loggers name

void decaf::util::logging::LogRecord::setSourceFunction

(

const std::string &

functionName

)

[inline]

Sets the name of the function where this log was logged.

Parameters:

functionName

the source of the log

void decaf::util::logging::LogRecord::setSourceLine

(

unsigned int

sourceLine

)

[inline]

Sets the Source Log line number.

Parameters:

sourceLine

the source logger's line number

void decaf::util::logging::LogRecord::setThrown

(

decaf::lang::Throwable *

thrown

)

[inline]

Sets the Throwable associated with this LogRecord, the pointer becomes the property of this instance of the LogRecord and will be deleted when the record is destroyed.

Parameters:

thrown

A pointer to a Throwable that will be associated with this record.

void decaf::util::logging::LogRecord::setTimestamp

(

long long

timeStamp

)

[inline]

Sets the time in mills that this message was logged.

Parameters:

timeStamp

UTC Time in Milliseconds.

void decaf::util::logging::LogRecord::setTreadId

(

long long

threadId

)

[inline]

Sets the Thread Id where this Log was created.

Parameters:

threadId

the source logger's line number

---

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

• src/main/decaf/util/logging/LogRecord.h