org.opendaylight.vtn.manager.internal.util.log

Enum VTNLogLevel

java.lang.Object

java.lang.Enum<VTNLogLevel>

org.opendaylight.vtn.manager.internal.util.log.VTNLogLevel

All Implemented Interfaces:

Serializable, Comparable<VTNLogLevel>

public enum VTNLogLevel
extends Enum<VTNLogLevel>

VTNLogLevel defines a set of logging level for VTN internal messages.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEBUG Indicates the DEBUG level.
ERROR Indicates the ERROR level.
INFO Indicates the INFO level.
TRACE Indicates the TRACE level.
WARN Indicates the WARN level.

Method Summary

Modifier and Type	Method and Description
boolean	isEnabled(org.slf4j.Logger logger) Determine whether the logging is enabled or not.
void	log(org.slf4j.Logger logger, String msg) Log the specified message.
void	log(org.slf4j.Logger logger, String format, Object... args) Log a message according to the specified format string and arguments.
void	log(org.slf4j.Logger logger, String msg, Throwable t) Log the specified message and exception.
void	log(org.slf4j.Logger logger, Throwable t, String format, Object... args) Log the specified throwable and a message according to the given format string and arguments.
static VTNLogLevel	valueOf(String name) Returns the enum constant of this type with the specified name.
static VTNLogLevel[]	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

ERROR

public static final VTNLogLevel ERROR

Indicates the ERROR level.

WARN

public static final VTNLogLevel WARN

Indicates the WARN level.

INFO

public static final VTNLogLevel INFO

Indicates the INFO level.

DEBUG

public static final VTNLogLevel DEBUG

Indicates the DEBUG level.

TRACE

public static final VTNLogLevel TRACE

Indicates the TRACE level.

Method Detail

values

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

Returns:

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

valueOf

public static VTNLogLevel 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

log

public void log(org.slf4j.Logger logger,
                Throwable t,
                String format,
                Object... args)

Log the specified throwable and a message according to the given format string and arguments.

Note that this method constructs a log message using String.format(String, Object[]).

Parameters:

logger - A Logger instance.

t - A Throwable to be logged.

format - A format string used to construct log message.

args - An object array used to construct log message.

isEnabled

public boolean isEnabled(org.slf4j.Logger logger)

Determine whether the logging is enabled or not.

Parameters:

logger - A Logger instance.

Returns:

true only if the logging is enabled.

log

public void log(org.slf4j.Logger logger,
                String msg)

Log the specified message.

Parameters:

logger - A Logger instance.

msg - A message to be logged.

log

public void log(org.slf4j.Logger logger,
                String format,
                Object... args)

Log a message according to the specified format string and arguments.

This method constructs a message using SLF4J log format.

Parameters:

logger - A Logger instance.

format - A format string used to construct log message.

args - An object array used to construct log message.

log

public void log(org.slf4j.Logger logger,
                String msg,
                Throwable t)

Log the specified message and exception.

Parameters:

logger - A Logger instance.

msg - A message to be logged.

t - A Throwable to be logged.