Package zipkin2.codec

Enum SpanBytesDecoder

java.lang.Object

java.lang.Enum<SpanBytesDecoder>

zipkin2.codec.SpanBytesDecoder

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SpanBytesDecoder>, BytesDecoder<Span>

public enum SpanBytesDecoder
extends java.lang.Enum<SpanBytesDecoder>
implements BytesDecoder<Span>

This is separate from SpanBytesEncoder, as it isn't needed for instrumentation

Enum Constant Summary

Enum Constants

Enum Constant	Description
JSON_V1	Corresponds to the Zipkin v1 json format
JSON_V2	Corresponds to the Zipkin v2 json format
PROTO3
THRIFT	Corresponds to the Zipkin v1 thrift format

Method Summary

Modifier and Type	Method	Description
abstract java.util.List<Span>	decodeList(java.nio.ByteBuffer spans)	ByteBuffer implementation of BytesDecoder.decodeList(byte[]).
abstract boolean	decodeList(java.nio.ByteBuffer spans, java.util.Collection<Span> out)	ByteBuffer implementation of BytesDecoder.decodeList(byte[]).
abstract Span	decodeOne(java.nio.ByteBuffer span)	ByteBuffer implementation of BytesDecoder.decodeOne(byte[])
static SpanBytesDecoder	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static SpanBytesDecoder[]	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.BytesDecoder

decode, decodeList, decodeList, decodeOne, encoding

Enum Constant Detail

JSON_V1

public static final SpanBytesDecoder JSON_V1

Corresponds to the Zipkin v1 json format

THRIFT

public static final SpanBytesDecoder THRIFT

Corresponds to the Zipkin v1 thrift format

JSON_V2

public static final SpanBytesDecoder JSON_V2

Corresponds to the Zipkin v2 json format

PROTO3

public static final SpanBytesDecoder PROTO3

Method Detail

values

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

Returns:

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

valueOf

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

decodeList

public abstract boolean decodeList(java.nio.ByteBuffer spans,
                                   java.util.Collection<Span> out)

ByteBuffer implementation of BytesDecoder.decodeList(byte[]).

Note: only use this when it is ok to modify the underlying ByteBuffer.array().

decodeList

public abstract java.util.List<Span> decodeList(java.nio.ByteBuffer spans)

ByteBuffer implementation of BytesDecoder.decodeList(byte[]).

Note: only use this when it is ok to modify the underlying ByteBuffer.array().

decodeOne

@Nullable
public abstract Span decodeOne(java.nio.ByteBuffer span)

ByteBuffer implementation of BytesDecoder.decodeOne(byte[])

Note: only use this when it is ok to modify the underlying ByteBuffer.array().