com.newrelic.agent.tracing

Enum Sampled

java.lang.Object

java.lang.Enum<Sampled>

com.newrelic.agent.tracing.Sampled

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Sampled>

public enum Sampled
extends java.lang.Enum<Sampled>

Represents whether or not a New Relic span has been sampled.

Enum Constant Summary

Enum Constants

Enum Constant and Description
SAMPLED_NO
SAMPLED_YES
UNKNOWN

Method Summary

Modifier and Type	Method and Description
boolean	booleanValue()
static Sampled	parse(java.lang.Object value) Turns a value into a Sampled enum.
static Sampled	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Sampled[]	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

SAMPLED_YES

public static final Sampled SAMPLED_YES

SAMPLED_NO

public static final Sampled SAMPLED_NO

UNKNOWN

public static final Sampled UNKNOWN

Method Detail

values

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

Returns:

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

valueOf

public static Sampled valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

parse

public static Sampled parse(java.lang.Object value)

Turns a value into a Sampled enum. This isn't a generic boolean parser, but is instead intended to only handle the simple cases offered by DT and W3C headers.

Returns:

SAMPLED_YES if "1" or true, SAMPLED_NO if "0" or false, and UNKNOWN otherwise.

booleanValue

public boolean booleanValue()