com.hazelcast.internal.metrics

Enum ProbeLevel

java.lang.Object

java.lang.Enum<ProbeLevel>

com.hazelcast.internal.metrics.ProbeLevel

All Implemented Interfaces:

Serializable, Comparable<ProbeLevel>

public enum ProbeLevel
extends Enum<ProbeLevel>

With the probe level one can control which probes are being tracked by the MetricsRegistry and which ones are not.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEBUG Indicates that is a probe for debugging purposes.
INFO Indicates that it is a regular probe.
MANDATORY Indicates that a probe is mandatory.

Method Summary

Modifier and Type	Method and Description
boolean	isEnabled(ProbeLevel minimumLevel) Checks if the this ProbeLevel has a precedence equal or higher than the minimumLevel.
static ProbeLevel	valueOf(String name) Returns the enum constant of this type with the specified name.
static ProbeLevel[]	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

MANDATORY

public static final ProbeLevel MANDATORY

Indicates that a probe is mandatory. E.g. memory usage, since other parts of the system rely on it (e.g the health monitor)

INFO

public static final ProbeLevel INFO

Indicates that it is a regular probe.

DEBUG

public static final ProbeLevel DEBUG

Indicates that is a probe for debugging purposes.

Method Detail

values

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

Returns:

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

valueOf

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

isEnabled

public boolean isEnabled(ProbeLevel minimumLevel)

Checks if the this ProbeLevel has a precedence equal or higher than the minimumLevel.

Parameters:

minimumLevel - the minimum ProbeLevel

Returns:

true if it is trackable, false otherwise.