de.frame4j.util

Enum Verbos

java.lang.Object

java.lang.Enum<Verbos>

de.frame4j.util.Verbos

All Implemented Interfaces:

Serializable, Comparable<Verbos>

@MinDoc(copyright="Copyright 2021  A. Weinert",
        author="Albrecht Weinert",
        version="V.50",
        lastModified="4.06.2021",
        usage="use the basic services",
        purpose="replace AppHelper\' verbosity")
public enum Verbos
extends Enum<Verbos>

Verbosity of applications.

This enumeration describes Frame4J's levels of application verbosity.
It replaces the respective constants and methods formerly in AppHelper. And it breaks the almost three decades tradition of higher numerical values meaning more silent. For backward compatibility a Verbos object holds its traditional level in tradVal, also.
Copyright © 2021 Albrecht Weinert

   weinert-automation.de        a-weinert.de

     /         /      /\
    /         /___   /  \      |
    \        /____\ /____\ |  _|__
     \  /\  / \    /      \|   |
      \/  \/   \__/        \__/|_

Version:

50 (4.06.2021)

See Also:

AppHelper, App

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEBUG Search faults or programming errors, commissioning mode.
ERROR Only report unusual incidents.
NORMAL Standard report level, normal mode.
SILENT Say almost nothing.
TEST Finer reports, test/simulate mode.
VERBOSE Detailed (verbose) reports.

Field Summary

Fields

Modifier and Type	Field and Description
static Action[]	LEVEL_CHOOSE Action list for report level.
String	name The name of this Verbosity.
int	tradVal The traditional (1999) value for this Verbosity.
int	val The normal (ascending, 2021) value for this Verbosity.
boolean	verbose Its verbose (or more).

Method Summary

Modifier and Type	Method and Description
static Verbos	byValue(int value) Get verbosity by value.
static Verbos	getVerbosity(String verbosity) Determine report level from text.
Level	getVerbosityLevel() Logging API's level by integer detailedness.
boolean	isDebug() All reports — for test and debugging.
boolean	isNormal() Do the normal reports.
boolean	isSilent() Almost no reports.
boolean	isTest() Many reports — for testing.
boolean	isVerbose() Report detailedness of this application.
String	toString() Detailedness of reports or logging.
static Verbos	valueOf(String name) Returns the enum constant of this type with the specified name.
static Verbos[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SILENT

public static final Verbos SILENT

Say almost nothing.

ERROR

public static final Verbos ERROR

Only report unusual incidents.

NORMAL

public static final Verbos NORMAL

Standard report level, normal mode.

VERBOSE

public static final Verbos VERBOSE

Detailed (verbose) reports.

TEST

public static final Verbos TEST

Finer reports, test/simulate mode.

DEBUG

public static final Verbos DEBUG

Search faults or programming errors, commissioning mode.

Field Detail

name

public final String name

The name of this Verbosity.

tradVal

public final int tradVal

The traditional (1999) value for this Verbosity.

val

public final int val

The normal (ascending, 2021) value for this Verbosity.

verbose

public final boolean verbose

Its verbose (or more).

This is true for VERBOSE, TEST and DEBUG.

LEVEL_CHOOSE

public static final Action[] LEVEL_CHOOSE

Action list for report level.

See table at toString().

Languages: English (partly German).

See Also:

Action.select(Action[], de.frame4j.util.Action.Filter, CharSequence, boolean)

Method Detail

values

public static Verbos[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Verbos c : Verbos.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Verbos valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getVerbosityLevel

public Level getVerbosityLevel()

Logging API's level by integer detailedness.

See table at toString().

See Also:

App.setVerbosity(int)

toString

public final String toString()

Detailedness of reports or logging.

One common way to designate the detailedness or frequency of reports or log entries is by the assignment of integer values, here in the range of 0 to 1000, called levels.
Levels like this have a double meaning:
At one hand they are assigned to an event or the report about, whereby higher values mean higher severity (no meaning to catastrophic) of the event or the importance of the report or log.
On the other hand the level serves as a threshold in the sense that reports of levels lower than threshold are not generated at all or filtered out.

Such "generating threshold" may be assigned to an application, but also to every agent, class or object. Very often, only two — verbose or not — or three levels — silent, normal and verbose — are distinguished, but seldom more than five /as defined here) make sense.

val (trad)	name	description	logging API name
60 (300)	debug	test, debug and commissioning reports	FINEST
50 (400)	test	commissioning and some tests	FINER
40 (500)	verbose	single agent (normal) state changes and events	FINE
30 (700)	normal	configuration / plant state changes and events, start up and shut down	CONFIG
20 (900)	error	only errors and failures	WARNING
10 (1000)	silent	no reports, except catastrophic	SEVERE

The usual default is 700 (=normal).

Overrides:

toString in class Enum<Verbos>

Returns:

the Verbos object's name; see table

See Also:

App.setVerbosity(int), Level

byValue

public static final Verbos byValue(int value)

Get verbosity by value.

This method returns a Verbos object by its value or by its tradVal (traditional level).

Parameters:

value - val (5..65) or tradVal (1050..250)

Returns:

a Verbos object matching the value; otherwise NORMAL

isTest

public final boolean isTest()

Many reports — for testing.

If true many events, also to a very fine granularity (normally of low relevance for the process done or controlled by this application), are generated.

Returns:

true if this is of level TEST or higher

See Also:

isVerbose(), isSilent(), isNormal()

isDebug

public final boolean isDebug()

All reports — for test and debugging.

If true many events, also programme technical ones (normally of nil relevance for the process done or controlled by this application), are generated.

Returns:

the current verbosity level; true: debug (or more)

See Also:

isVerbose(), isSilent(), isNormal()

isVerbose

public final boolean isVerbose()

Report detailedness of this application.

This is true for all Verbos levels above NORMAL.

Returns:

just the value of verbose

isSilent

public final boolean isSilent()

Almost no reports.

If true only reports on catastrophic events are to be generated.

Returns:

the current verbosity level; true for SILENT

See Also:

isVerbose(), isNormal()

isNormal

public final boolean isNormal()

Do the normal reports.

If true the so called "normal" events shall be generated, those of every day relevance for the process done or controlled by this application.

Returns:

the current verbosity level; true: normal (or more)

See Also:

isVerbose(), isSilent()

getVerbosity

public static Verbos getVerbosity(String verbosity)

Determine report level from text.

The (key) words and numbers in the table at toString() are recognised.
The match is case insensitive and allows for abbreviations like err or err. instead off error, e.g.. If no match is found NORMAL is returned.

Parameters:

verbosity - key word or number

See Also:

toString(), Action.select(Action[], de.frame4j.util.Action.Filter, CharSequence, boolean)