Top Description Fields Constructors Methods
io.opentelemetry.api.trace

public final Class SpanId

extends Object
Class Inheritance
Annotations
@Immutable
Imports
io.opentelemetry.api.internal.ApiUsageLogger, .OtelEncodingUtils, .TemporaryBuffers, javax.annotation.concurrent.Immutable
Helper methods for dealing with a span identifier. A valid span identifier is a 16 character lowercase hex (base16) String, where at least one of the characters is not a "0".

There are two more other representation that this class helps with:

Field Summary

Modifier and TypeField and Description
private static final int
BYTES_LENGTH

private static final int
HEX_LENGTH

private static final String
INVALID

Constructor Summary

AccessConstructor and Description
private
SpanId()

Method Summary

Modifier and TypeMethod and Description
public static String

Returns:

the lowercase hex (base16) representation of the SpanId.
fromBytes(byte[]
the bytes (8-byte array) representation of the SpanId.
spanIdBytes)

Returns the lowercase hex (base16) representation of the SpanId converted from the given bytes representation, or getInvalid() if input is null or the given byte array is too short.

public static String

Returns:

the lowercase hex (base16) representation of the SpanId.
fromLong(long
long value representation of the SpanId.
id)

Returns the lowercase hex (base16) representation of the SpanId converted from the given long value representation.

public static String

Returns:

the invalid SpanId lowercase in hex (base16) representation.
getInvalid()

Returns the invalid SpanId in lowercase hex (base16) representation.

public static int

Returns:

the length of the lowercase hex (base16) representation of the SpanId.
getLength()

Returns the length of the lowercase hex (base16) representation of the SpanId.

public static boolean

Returns:

true if the span identifier is valid.
isValid(CharSequence spanId)

Returns whether the span identifier is valid.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

BYTES_LENGTHback to summary
private static final int BYTES_LENGTH
HEX_LENGTHback to summary
private static final int HEX_LENGTH
INVALIDback to summary
private static final String INVALID

Constructor Detail

SpanIdback to summary
private SpanId()

Method Detail

fromBytesback to summary
public static String fromBytes(byte[] spanIdBytes)

Returns the lowercase hex (base16) representation of the SpanId converted from the given bytes representation, or getInvalid() if input is null or the given byte array is too short.

It converts the first 8 bytes of the given byte array.

Parameters
spanIdBytes:byte[]

the bytes (8-byte array) representation of the SpanId.

Returns:String

the lowercase hex (base16) representation of the SpanId.

fromLongback to summary
public static String fromLong(long id)

Returns the lowercase hex (base16) representation of the SpanId converted from the given long value representation.

There is no restriction on the specified values, other than the already established validity rules applying to SpanId. Specifying 0 for the long value will effectively return getInvalid().

This is equivalent to calling fromBytes(byte[]) with the specified value stored as big-endian.

Parameters
id:long

long value representation of the SpanId.

Returns:String

the lowercase hex (base16) representation of the SpanId.

getInvalidback to summary
public static String getInvalid()

Returns the invalid SpanId in lowercase hex (base16) representation. All characters are "0".

Returns:String

the invalid SpanId lowercase in hex (base16) representation.

getLengthback to summary
public static int getLength()

Returns the length of the lowercase hex (base16) representation of the SpanId.

Returns:int

the length of the lowercase hex (base16) representation of the SpanId.

isValidback to summary
public static boolean isValid(CharSequence spanId)

Returns whether the span identifier is valid. A valid span identifier is a 16 character hex String, where at least one of the characters is not a '0'.

Returns:boolean

true if the span identifier is valid.