zipkin2.codec

Enum SpanBytesEncoder

java.lang.Object

java.lang.Enum<SpanBytesEncoder>

zipkin2.codec.SpanBytesEncoder

All Implemented Interfaces:

Serializable, Comparable<SpanBytesEncoder>, BytesEncoder<Span>

public enum SpanBytesEncoder
extends Enum<SpanBytesEncoder>
implements BytesEncoder<Span>

Limited interface needed by those writing span reporters

Enum Constant Summary

Enum Constants

Enum Constant and Description
JSON_V1 Corresponds to the Zipkin v1 json format (with tags as binary annotations)
JSON_V2 Corresponds to the Zipkin v2 json format
PROTO3
THRIFT Corresponds to the Zipkin v1 thrift format

Method Summary

Modifier and Type	Method and Description
abstract int	encodeList(List<Span> spans, byte[] out, int pos) Allows you to encode a list of spans onto a specific offset.
static SpanBytesEncoder	valueOf(String name) Returns the enum constant of this type with the specified name.
static SpanBytesEncoder[]	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 zipkin2.codec.BytesEncoder

encode, encodeList, encoding, sizeInBytes

Enum Constant Detail

JSON_V1

public static final SpanBytesEncoder JSON_V1

Corresponds to the Zipkin v1 json format (with tags as binary annotations)

THRIFT

public static final SpanBytesEncoder THRIFT

Corresponds to the Zipkin v1 thrift format

JSON_V2

public static final SpanBytesEncoder JSON_V2

Corresponds to the Zipkin v2 json format

PROTO3

public static final SpanBytesEncoder PROTO3

Method Detail

values

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

Returns:

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

valueOf

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

encodeList

public abstract int encodeList(List<Span> spans,
                               byte[] out,
                               int pos)

Allows you to encode a list of spans onto a specific offset. For example, when nesting