org.hawkular.apm.api.model.trace

Enum CorrelationIdentifier.Scope

java.lang.Object

java.lang.Enum<CorrelationIdentifier.Scope>

org.hawkular.apm.api.model.trace.CorrelationIdentifier.Scope

All Implemented Interfaces:

Serializable, Comparable<CorrelationIdentifier.Scope>

Enclosing class:

CorrelationIdentifier

public static enum CorrelationIdentifier.Scope
extends Enum<CorrelationIdentifier.Scope>

This enumerated value represents the scope of the correlation identifier.

Author:

gbrown

Enum Constant Summary

Enum Constants

Enum Constant and Description
CausedBy This scope is used to reference a node within another fragment.
ControlFlow This scope means the identifier is a unique value shared between one source node and potentially zero or more target nodes.
Interaction This scope means the identifier's value is unique and shared between a source (Producer) and zero or more target (Consumer) nodes.

Method Summary

Modifier and Type	Method and Description
static CorrelationIdentifier.Scope	valueOf(String name) Returns the enum constant of this type with the specified name.
static CorrelationIdentifier.Scope[]	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

Interaction

public static final CorrelationIdentifier.Scope Interaction

This scope means the identifier's value is unique and shared between a source (Producer) and zero or more target (Consumer) nodes.

ControlFlow

public static final CorrelationIdentifier.Scope ControlFlow

This scope means the identifier is a unique value shared between one source node and potentially zero or more target nodes. The value can be randomly generated (as in the case of establishing a link between concurrent fragments) or represent some application/ business context (e.g. unique value based on order id). This value must be unique within and across all trace instances - otherwise it will be impossible to correctly associated with the source and target nodes.

CausedBy

public static final CorrelationIdentifier.Scope CausedBy

This scope is used to reference a node within another fragment. Unlike the Interaction and ControlFlow scopes, which achieve correlation by sharing a common value between the source and target nodes, this scope is a "one-way" reference from the target node back to a source node.

Method Detail

values

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

Returns:

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

valueOf

public static CorrelationIdentifier.Scope 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