io.opentelemetry.trace

Class SpanId

java.lang.Object

io.opentelemetry.trace.SpanId

All Implemented Interfaces:

Comparable<SpanId>

@Immutable
public final class SpanId
extends Object
implements Comparable<SpanId>

A class that represents a span identifier. A valid span identifier is an 8-byte array with at least one non-zero byte.

Since:

0.1.0

Constructor Summary

Constructors

Constructor and Description
SpanId(long id) Constructs a SpanId whose representation is specified by a long value.

Method Summary

Modifier and Type	Method and Description
int	compareTo(SpanId that)
void	copyBytesTo(byte[] dest, int destOffset) Copies the byte array representations of the SpanId into the dest beginning at the destOffset offset.
void	copyLowerBase16To(char[] dest, int destOffset) Copies the lowercase base16 representations of the SpanId into the dest beginning at the destOffset offset.
boolean	equals(Object obj)
static SpanId	fromBytes(byte[] src, int srcOffset) Returns a SpanId whose representation is copied from the src beginning at the srcOffset offset.
static SpanId	fromLowerBase16(CharSequence src, int srcOffset) Returns a SpanId built from a lowercase base16 representation.
static SpanId	getInvalid() Returns the invalid SpanId.
static int	getSize() Returns the size in bytes of the SpanId.
int	hashCode()
boolean	isValid() Returns whether the span identifier is valid.
String	toLowerBase16() Returns the lowercase base16 encoding of this SpanId.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SpanId

public SpanId(long id)

Constructs a SpanId whose representation is specified by a long value.

There is no restriction on the specified value, other than the already established validity rules applying to SpanId. Specifying 0 for this value will effectively make the new SpanId invalid.

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

Parameters:

id - the long representation of the TraceId.

Since:

0.1.0

Method Detail

getSize

public static int getSize()

Returns the size in bytes of the SpanId.

Returns:

the size in bytes of the SpanId.

Since:

0.1.0

getInvalid

public static SpanId getInvalid()

Returns the invalid SpanId. All bytes are 0.

Returns:

the invalid SpanId.

Since:

0.1.0

fromBytes

public static SpanId fromBytes(byte[] src,
                               int srcOffset)

Returns a SpanId whose representation is copied from the src beginning at the srcOffset offset.

Parameters:

src - the buffer where the representation of the SpanId is copied.

srcOffset - the offset in the buffer where the representation of the SpanId begins.

Returns:

a SpanId whose representation is copied from the buffer.

Throws:

NullPointerException - if src is null.

IndexOutOfBoundsException - if srcOffset+SpanId.getSize() is greater than src.length.

Since:

0.1.0

copyBytesTo

public void copyBytesTo(byte[] dest,
                        int destOffset)

Copies the byte array representations of the SpanId into the dest beginning at the destOffset offset.

Parameters:

dest - the destination buffer.

destOffset - the starting offset in the destination buffer.

Throws:

NullPointerException - if dest is null.

IndexOutOfBoundsException - if destOffset+SpanId.getSize() is greater than dest.length.

Since:

0.1.0

fromLowerBase16

public static SpanId fromLowerBase16(CharSequence src,
                                     int srcOffset)

Returns a SpanId built from a lowercase base16 representation.

Parameters:

src - the lowercase base16 representation.

srcOffset - the offset in the buffer where the representation of the SpanId begins.

Returns:

a SpanId built from a lowercase base16 representation.

Throws:

NullPointerException - if src is null.

IllegalArgumentException - if not enough characters in the src from the srcOffset.

Since:

0.1.0

copyLowerBase16To

public void copyLowerBase16To(char[] dest,
                              int destOffset)

Copies the lowercase base16 representations of the SpanId into the dest beginning at the destOffset offset.

Parameters:

dest - the destination buffer.

destOffset - the starting offset in the destination buffer.

Throws:

IndexOutOfBoundsException - if destOffset + 2 * SpanId.getSize() is greater than dest.length.

Since:

0.1.0

isValid

public boolean isValid()

Returns whether the span identifier is valid. A valid span identifier is an 8-byte array with at least one non-zero byte.

Returns:

true if the span identifier is valid.

Since:

0.1.0

toLowerBase16

public String toLowerBase16()

Returns the lowercase base16 encoding of this SpanId.

Returns:

the lowercase base16 encoding of this SpanId.

Since:

0.1.0

equals

public boolean equals(@Nullable
                      Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(SpanId that)

Specified by:

compareTo in interface Comparable<SpanId>