ALox  V. 2402 R. 0
Home ALox for C++ ALox for C# ALox for Java Download
Public Fields | List of all members
Verbosity Enum Reference

Class Description


This enum is used in ALox to control the 'verbosity' or 'verboseness' of the log output. The values herein - apart from special value 'OFF' - are sorted in the following order

A value of this set is provided to ALox in two different ways: First, all methods of class Lox that execute a log operation assign a value of this enum to the Log Statement. Secondly, methods Lox.setVerbosity, are defining the 'accepted' minimal Verbosity for a pair of <Logger/Log Domain>.

ALox, when executing a statement, checks both values against each other. A Log Statement is executed, when the <Logger/Log Domain> setting is set to the same or a 'higher level'. For example if a <Logger/Log Domain> setting is WARNING, then Log Statements with associated Verbosity WARNING and ERROR are executed and those with INFO and VERBOSE are suppressed.

If special value OFF is used with Lox.setVerbosity, all logging is switched OFF for this pair of <Logger/Log Domain>.

Some of the Log Statements accept the parameter directly (e.g. Lox.entry, Lox.once and Lox.If), others inherently use the right value as their method name suggests (e.g. Lox.error, Lox.warning, Lox.info, Lox.verbose and Lox.Assert). The latter group of methods do not support parameter OFF.

If special value OFF is used with those Log Statements, that allow to specify the Verbosity as a parameter, the Log Statement is never executed This is useful if the parameter is determined at runtime, depending on the state of an application.

Public Fields

 ERROR
 
 INFO
 
 OFF
 
 VERBOSE
 
 WARNING
 

Member Data Documentation

◆ ERROR

ERROR

A Verbosity for error messages. It is suppressed only if a Log Domains' setting is OFF.

◆ INFO

INFO

The standard Verbosity for normal log output statements. Logged if a Log Domain is set to INFO or VERBOSE.

◆ OFF

OFF

Statements with this value associated are never logged (useful if Verbosity is evaluated at runtime). Log Domains with this setting do not execute any Log Statement.

◆ VERBOSE

VERBOSE

The 'highest' level of Verbosity. Statements with this value associated are logged only if a Log Domain is set to VERBOSE as well.

◆ WARNING

WARNING

A Verbosity for warning messages, hence things that might lead to errors or are not welcome for other reasons, but maybe are not errors.
Logged if a Log Domain is set to WARNING, INFO or VERBOSE.


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