decaf::util::logging::Level Class Reference

The Level class defines a set of standard logging levels that can be used to control logging output. More...

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

Inheritance diagram for decaf::util::logging::Level:

Public Member Functions
virtual	~Level ()
int	intValue () const
std::string	getName () const
std::string	toString () const
virtual int	compareTo (const Level &value) const
virtual bool	equals (const Level &value) const
virtual bool	operator== (const Level &value) const
virtual bool	operator< (const Level &value) const
Static Public Member Functions
static Level	parse (const std::string &name)
	Parse a level name string into a Level.
Static Public Attributes
static const Level	INHERIT
	NULL is a special level that indicates that the Logger should get its Level from its parent Logger, the value is initialized as zero.
static const Level	OFF
	OFF is a special level that can be used to turn off logging.
static const Level	SEVERE
	SEVERE is a message level indicating a serious failure.
static const Level	WARNING
	WARNING is a message level indicating a potential problem.
static const Level	INFO
	INFO is a message level for informational messages.
static const Level	DEBUG
	DEBUG is a level for more verbose informative messages.
static const Level	CONFIG
	CONFIG is a message level for static configuration messages.
static const Level	FINE
	FINE is a message level providing tracing information.
static const Level	FINER
	FINER indicates a fairly detailed tracing message.
static const Level	FINEST
	FINEST indicates a highly detailed tracing message.
static const Level	ALL
	ALL indicates that all messages should be logged.
Protected Member Functions
	Level (const std::string &name, int value)
	Create a named Level with a given integer value.

---

Detailed Description

The Level class defines a set of standard logging levels that can be used to control logging output.

The logging Level objects are ordered and are specified by ordered integers. Enabling logging at a given level also enables logging at all higher levels.

Clients should normally use the predefined Level constants such as Level.SEVERE.

The levels in descending order are:

* SEVERE (highest value) * WARNING * INFO * DEBUG * CONFIG * FINE * FINER * FINEST (lowest value)

In addition there is a level OFF that can be used to turn off logging, and a level ALL that can be used to enable logging of all messages.

It is possible for third parties to define additional logging levels by subclassing Level. In such cases subclasses should take care to chose unique integer level values.

Since:

1.0

---

Constructor & Destructor Documentation

decaf::util::logging::Level::Level	(	const std::string &	name,
		int	value
	)		[protected]

Create a named Level with a given integer value.

Parameters:

name	Name of the level, e.g. SEVERE
value	Unique integer value of this level, e.g. 100

virtual decaf::util::logging::Level::~Level

(

)

[virtual]

---

Member Function Documentation

virtual int decaf::util::logging::Level::compareTo

(

const Level &

value

)

const [virtual]

virtual bool decaf::util::logging::Level::equals

(

const Level &

value

)

const [virtual]

std::string decaf::util::logging::Level::getName

(

)

const [inline]

Returns:

the name of this Level instance.

int decaf::util::logging::Level::intValue

(

)

const [inline]

Returns:

the integer value of this level instance.

virtual bool decaf::util::logging::Level::operator<

(

const Level &

value

)

const [virtual]

virtual bool decaf::util::logging::Level::operator==

(

const Level &

value

)

const [virtual]

static Level decaf::util::logging::Level::parse

(

const std::string &

name

)

[static]

Parse a level name string into a Level.

The argument string may consist of either a level name or an integer value.

For example:

* "SEVERE" * "1000"

Parameters:

name	- The name or int value of the desired Level

Returns:

the parsed Level value, passing in a level name that is an int value that is not one of the known Level values will result in a new Level that has been initialized with that int value and name as the string form of the int.

Exceptions:

IllegalArgumentException

if the value is not valid, validity means that the string is either a valid int (between Integer::MIN_VALUE and Integer::MAX_VALUE or is one of the known level names.

std::string decaf::util::logging::Level::toString

(

)

const [inline]

Returns:

the string value of this Level, e.g. "SEVERE".

---

Field Documentation

const Level decaf::util::logging::Level::ALL [static]

ALL indicates that all messages should be logged.

This level is initialized to Integer::MIN_VALUE.

const Level decaf::util::logging::Level::CONFIG [static]

CONFIG is a message level for static configuration messages.

CONFIG messages are intended to provide a variety of static configuration information, to assist in debugging problems that may be associated with particular configurations. For example, CONFIG message might include the CPU type, the System properties, etc. This level is initialized to 600.

const Level decaf::util::logging::Level::DEBUG [static]

DEBUG is a level for more verbose informative messages.

DEBUG messages are intended to provide a more detailed message intended for use by developers in tracking the behavior of a client. DEBUG messages typically contain more implementation specific information that might not be significant to end users or system admins. This level is initialized to 700.

const Level decaf::util::logging::Level::FINE [static]

FINE is a message level providing tracing information.

All of FINE, FINER, and FINEST are intended for relatively detailed tracing. The exact meaning of the three levels will vary between subsystems, but in general, FINEST should be used for the most detailed output, FINER for somewhat less detailed output, and FINE for the lowest volume (and most important) messages.

In general the FINE level should be used for information that will be broadly interesting to developers who do not have a specialized interest in the specific subsystem.

FINE messages might include things like minor (recoverable) failures. Issues indicating potential performance problems are also worth logging as FINE. This level is initialized to 500.

const Level decaf::util::logging::Level::FINER [static]

FINER indicates a fairly detailed tracing message.

By default logging calls for entering, returning, or throwing an exception are traced at this level. This level is initialized to 400.

const Level decaf::util::logging::Level::FINEST [static]

FINEST indicates a highly detailed tracing message.

This level is initialized to 300.

const Level decaf::util::logging::Level::INFO [static]

INFO is a message level for informational messages.

Typically INFO messages will be written to the console or its equivalent. So the INFO level should only be used for reasonably significant messages that will make sense to end users and system admins. This level is initialized to 800.

const Level decaf::util::logging::Level::INHERIT [static]

NULL is a special level that indicates that the Logger should get its Level from its parent Logger, the value is initialized as zero.

const Level decaf::util::logging::Level::OFF [static]

OFF is a special level that can be used to turn off logging.

This level is initialized to Integer::MAX_VALUE

const Level decaf::util::logging::Level::SEVERE [static]

SEVERE is a message level indicating a serious failure.

In general SEVERE messages should describe events that are of considerable importance and which will prevent normal program execution. They should be reasonably intelligible to end users and to system administrators. This level is initialized to 1000.

const Level decaf::util::logging::Level::WARNING [static]

WARNING is a message level indicating a potential problem.

In general WARNING messages should describe events that will be of interest to end users or system managers, or which indicate potential problems. This level is initialized to 900.

---

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

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