Library.IO.Logging.Logs.ANullMessageLog Class Reference

A null message log. More...

Inheritance diagram for Library.IO.Logging.Logs.ANullMessageLog:

Public Member Functions
def	log
	Log the specified item. More...
Public Member Functions inherited from Library.IO.Logging.Logs.AMessageLog
def	__init__
	Construct a new message log that will output messages to the specified stream or file name. More...
def	init
	Initializer.
def	__del__
	Destructor.
def	addCounterNamed
	Add the named counter to the list of counters managed by the log. More...
def	log
	Log the specified item to the log. More...
def	toString
	Return a string representation of the message log. More...
def	printTo
	Print a string representation of the message log and its counters to the specified stream. More...
def	Counter
	Retrieve the named counter. More...
def	Counters
	Retrieve the list of counters managed by the message log. More...
def	Output
	Retrieve a reference to the output stream used by the message log. More...
Public Member Functions inherited from Library.Base.Classwork.AnObject
def	init
	Initialize a new object instance. More...
def	__init__
	Construct and initialize a new instance of AnObject. More...
def	__del__
	Destroy the object instance. More...
def	displayName
	Construct a "pretty" display name for the class instance, based on the name of its class. More...
def	implements
	Determine whether the class instance is related to the specified class. More...
def	toString
	Return a string representation of the class, suitable for output to a console or text-based device. More...
def	__str__
	Return a string representation of the class. More...
def	classname
	Return the name of the class from which the instance was created. More...
def	name
	Return the name of the class. More...
Public Member Functions inherited from Library.String.Utilities.IsPrintable
def	toString
	Return a string representation of the class conveniently. More...
def	__str__
	Return a string representation of the class. More...
def	printTo
	Print a string representation of the class to the specified stream. More...

Detailed Description

A null message log.

This class does not do much. Its log() method simply returns the message object with which it is called, so that the method can still be used as part of an exception-raising statement. The class is designed for those instances where a class may depend upon having a log but, for whatever reason, no logging is actually to be done. This class can be used in those instances where a reference to a message log is required in order to prevent code from breaking – the author, however, considers it a hack and something to remove at some point.

Member Function Documentation

def Library.IO.Logging.Logs.ANullMessageLog.log	(		Self,
			ThisItem,
			freeItem = True
	)

Log the specified item.

This method does nothing but return ThisItem, so that a call to it can be used as part of an exception-raising statement.

---

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

• Library/IO/Logging/Logs.py