org.wso2.siddhi.core.util.statistics.metrics

Class Level

java.lang.Object

org.wso2.siddhi.core.util.statistics.metrics.Level

All Implemented Interfaces:

Comparable<Level>

public class Level
extends Object
implements Comparable<Level>

This class defines a set of standard levels to be used in SP Metrics. This class is similar to org.apache.logging.log4j.Level in Apache Log4j 2 project.

Levels are organized from most specific to least:

• OFF (most specific, no metrics)
• BASIC
• DETAIL

Field Summary

Fields

Modifier and Type	Field and Description
static Level	BASIC A metric for informational purposes.
static Level	DETAIL A general debugging metric.
static Level	OFF No events will be used for metrics.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Level other)
boolean	equals(Object other)
int	hashCode()
String	name() Gets the symbolic name of this Level.
String	toString()
static Level	valueOf(String name) Return the Level associated with the name.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

OFF

public static final Level OFF

No events will be used for metrics.

BASIC

public static final Level BASIC

A metric for informational purposes.

DETAIL

public static final Level DETAIL

A general debugging metric.

Method Detail

compareTo

public int compareTo(Level other)

Specified by:

compareTo in interface Comparable<Level>

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

name

public String name()

Gets the symbolic name of this Level. Equivalent to calling toString().

Returns:

the name of this Level.

toString

public String toString()

Overrides:

toString in class Object

valueOf

public static Level valueOf(String name)

Return the Level associated with the name.

Parameters:

name - The name of the Level to return.

Returns:

The Level.

Throws:

NullPointerException - if the Level name is null.

IllegalArgumentException - if the Level name is not registered.