Package org.eclipse.hono.util

Enum Class TracingSamplingMode

java.lang.Object

java.lang.Enum<TracingSamplingMode>

org.eclipse.hono.util.TracingSamplingMode

All Implemented Interfaces:

Serializable, Comparable<TracingSamplingMode>, Constable

public enum TracingSamplingMode
extends Enum<TracingSamplingMode>

Value that defines in how far OpenTracing spans shall be recorded (sampled) by the tracing system.

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
ALL
DEFAULT
NONE

Method Summary

Modifier and Type	Method	Description
static TracingSamplingMode	from(String value)	Construct a TraceSamplingMode from a value.
String	getFieldValue()	Gets the JSON field value for this TraceSamplingMode.
static TracingSamplingMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TracingSamplingMode[]	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

DEFAULT

public static final TracingSamplingMode DEFAULT

ALL

public static final TracingSamplingMode ALL

NONE

public static final TracingSamplingMode NONE

Method Details

values

public static TracingSamplingMode[] 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 TracingSamplingMode 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

getFieldValue

public String getFieldValue()

Gets the JSON field value for this TraceSamplingMode.

Returns:

The field value.

from

public static TracingSamplingMode from(String value)

Construct a TraceSamplingMode from a value.

Parameters:

value - The value from which the TraceSamplingMode needs to be constructed.

Returns:

The TraceSamplingMode as enum, or DEFAULT otherwise.