Package zipkin2.reporter.brave

Enum MutableSpanBytesEncoder

java.lang.Object

java.lang.Enum<MutableSpanBytesEncoder>

zipkin2.reporter.brave.MutableSpanBytesEncoder

All Implemented Interfaces:

Serializable, Comparable<MutableSpanBytesEncoder>, BytesEncoder<brave.handler.MutableSpan>

public enum MutableSpanBytesEncoder
extends Enum<MutableSpanBytesEncoder>
implements BytesEncoder<brave.handler.MutableSpan>

Includes built-in formats used in Zipkin.

Enum Constant Summary

Enum Constants

Enum Constant	Description
JSON_V2	Corresponds to the Zipkin v2 json format
PROTO3

Method Summary

Modifier and Type	Method	Description
static BytesEncoder<brave.handler.MutableSpan>	create(Encoding encoding, brave.Tag<Throwable> errorTag)	Like forEncoding(Encoding), except you can override the default throwable parser, which is Tags.ERROR.
static BytesEncoder<brave.handler.MutableSpan>	forEncoding(Encoding encoding)	Returns the default MutableSpan encoder for given encoding.
static MutableSpanBytesEncoder	valueOf(String name)	Returns the enum constant of this type with the specified name.
static MutableSpanBytesEncoder[]	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.reporter.BytesEncoder

encode, encoding, sizeInBytes

Enum Constant Detail

JSON_V2

public static final MutableSpanBytesEncoder JSON_V2

Corresponds to the Zipkin v2 json format

PROTO3

public static final MutableSpanBytesEncoder PROTO3

Method Detail

values

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

Returns:

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

valueOf

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

forEncoding

public static BytesEncoder<brave.handler.MutableSpan> forEncoding(Encoding encoding)

Returns the default MutableSpan encoder for given encoding.

Throws:

UnsupportedOperationException - if the encoding is not yet supported.

Since:

3.3

create

public static BytesEncoder<brave.handler.MutableSpan> create(Encoding encoding,
                                                             brave.Tag<Throwable> errorTag)

Like forEncoding(Encoding), except you can override the default throwable parser, which is Tags.ERROR.

Since:

3.3