io.github.robolib.util.log

Enum LogLevel

java.lang.Object

java.lang.Enum<LogLevel>

io.github.robolib.util.log.LogLevel

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<LogLevel>

public enum LogLevel
extends java.lang.Enum<LogLevel>

A Logging class.

Each Class that wishes to log must call the Logger.get method with itself as the only argument, or with an optional string value. This will return a new Logger object.

To log something, the Calling class must call the desired level method info, debug, warn, error, fatal with the message to be logged. If the calling the err or fatal classes, a Throwable object must be passed as a second argument. Calling the error method will only print the message and error stack trace. However, calling the fatal method will print the stack trace, and kill the program.

Author:

noriah

See Also:

ILogger, Logger, LogOutput

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEBUG The debug.
ERROR The error.
FATAL The fatal.
INFO The info.
SEVERE The severe.
WARN The warn.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	m_name The m_name.

Method Summary

Modifier and Type	Method and Description
static LogLevel	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static LogLevel[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INFO

public static final LogLevel INFO

The info.

DEBUG

public static final LogLevel DEBUG

The debug.

WARN

public static final LogLevel WARN

The warn.

ERROR

public static final LogLevel ERROR

The error.

SEVERE

public static final LogLevel SEVERE

The severe.

FATAL

public static final LogLevel FATAL

The fatal.

Field Detail

m_name

public final java.lang.String m_name

The m_name.

Method Detail

values

public static LogLevel[] 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 (LogLevel c : LogLevel.values())
    System.out.println(c);

Returns:

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

valueOf

public static LogLevel valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null