Package org.opendaylight.serviceutils.tools.rpc

Enum Class FutureRpcResults.LogLevel

java.lang.Object

java.lang.Enum<FutureRpcResults.LogLevel>

org.opendaylight.serviceutils.tools.rpc.FutureRpcResults.LogLevel

All Implemented Interfaces:

Serializable, Comparable<FutureRpcResults.LogLevel>, Constable

Enclosing class:

FutureRpcResults

public static enum FutureRpcResults.LogLevel
extends Enum<FutureRpcResults.LogLevel>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEBUG
ERROR
INFO
NONE	Note that when using LogLevel NONE for failures, then you should set a FutureRpcResults.FutureRpcResultBuilder.onFailure(Consumer) which does better logging, or be 100% sure that all callers of the RPC check the returned Future RpcResult appropriately; otherwise you will lose error messages.
TRACE
WARN

Method Summary

Modifier and Type	Method	Description
void	log(org.slf4j.Logger logger, String format, Object... arguments)
static FutureRpcResults.LogLevel	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FutureRpcResults.LogLevel[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ERROR

public static final FutureRpcResults.LogLevel ERROR

WARN

public static final FutureRpcResults.LogLevel WARN

INFO

public static final FutureRpcResults.LogLevel INFO

DEBUG

public static final FutureRpcResults.LogLevel DEBUG

TRACE

public static final FutureRpcResults.LogLevel TRACE

NONE

public static final FutureRpcResults.LogLevel NONE

Note that when using LogLevel NONE for failures, then you should set a FutureRpcResults.FutureRpcResultBuilder.onFailure(Consumer) which does better logging, or be 100% sure that all callers of the RPC check the returned Future RpcResult appropriately; otherwise you will lose error messages.

Method Details

values

public static FutureRpcResults.LogLevel[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static FutureRpcResults.LogLevel valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

log

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