Package brave.propagation

Enum B3Propagation.Format

java.lang.Object

java.lang.Enum<B3Propagation.Format>

brave.propagation.B3Propagation.Format

All Implemented Interfaces:

brave.internal.propagation.InjectorFactory.InjectorFunction, Serializable, Comparable<B3Propagation.Format>

Enclosing class:

B3Propagation<K>

public static enum B3Propagation.Format
extends Enum<B3Propagation.Format>
implements brave.internal.propagation.InjectorFactory.InjectorFunction

Describes the formats used to inject headers.

Enum Constant Summary

Enum Constants

Enum Constant	Description
MULTI	The trace context is encoded with a several fields prefixed with "x-b3-".
SINGLE	The trace context is encoded with B3SingleFormat.writeB3SingleFormat(TraceContext).
SINGLE_NO_PARENT	The trace context is encoded with B3SingleFormat.writeB3SingleFormatWithoutParentId(TraceContext).

Field Summary

Fields inherited from interface brave.internal.propagation.InjectorFactory.InjectorFunction

NOOP

Method Summary

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

Methods inherited from interface brave.internal.propagation.InjectorFactory.InjectorFunction

inject, keyNames

Enum Constant Detail

MULTI

public static final B3Propagation.Format MULTI

The trace context is encoded with a several fields prefixed with "x-b3-".

SINGLE

public static final B3Propagation.Format SINGLE

The trace context is encoded with B3SingleFormat.writeB3SingleFormat(TraceContext).

SINGLE_NO_PARENT

public static final B3Propagation.Format SINGLE_NO_PARENT

The trace context is encoded with B3SingleFormat.writeB3SingleFormatWithoutParentId(TraceContext).

Method Detail

values

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

Returns:

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

valueOf

public static B3Propagation.Format 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