io.opencensus.trace

Class SpanId

java.lang.Object

io.opencensus.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.

Field Summary

Fields

Modifier and Type	Field and Description
static SpanId	INVALID The invalid SpanId.
static int	SIZE The size in bytes of the SpanId.

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.
boolean	equals(Object obj)
static SpanId	fromBytes(byte[] buffer) Returns a SpanId built from a byte representation.
static SpanId	fromBytes(byte[] src, int srcOffset) Returns a SpanId whose representation is copied from the src beginning at the srcOffset offset.
static SpanId	generateRandomId(Random random) Generates a new random SpanId.
byte[]	getBytes() Returns the byte representation of the SpanId.
int	hashCode()
boolean	isValid() Returns whether the span identifier is valid.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SIZE

public static final int SIZE

The size in bytes of the SpanId.

See Also:

Constant Field Values

INVALID

public static final SpanId INVALID

The invalid SpanId. All bytes are 0.

Method Detail

fromBytes

public static SpanId fromBytes(byte[] buffer)

Returns a SpanId built from a byte representation.

Equivalent with:

 SpanId.fromBytes(buffer, 0);
 

Parameters:

buffer - the representation of the SpanId.

Returns:

a SpanId whose representation is given by the buffer parameter.

Throws:

NullPointerException - if buffer is null.

IllegalArgumentException - if buffer.length is not SIZE.

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.SIZE is greater than src.length.

generateRandomId

public static SpanId generateRandomId(Random random)

Generates a new random SpanId.

Parameters:

random - The random number generator.

Returns:

a valid new SpanId.

getBytes

public byte[] getBytes()

Returns the byte representation of the SpanId.

Returns:

the byte representation of the SpanId.

copyBytesTo

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

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

Equivalent with (but faster because it avoids any new allocations):

 System.arraycopy(getBytes(), 0, dest, destOffset, SpanId.SIZE);
 

Parameters:

dest - the destination buffer.

destOffset - the starting offset in the destination buffer.

Throws:

NullPointerException - if dest is null.

IndexOutOfBoundsException - if destOffset+SpanId.SIZE is greater than dest.length.

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.

equals

public boolean equals(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>