Package datadog.trace.api

Class DDTraceId

java.lang.Object

datadog.trace.api.DDTraceId

Direct Known Subclasses:

DD128bTraceId, DD64bTraceId

public abstract class DDTraceId
extends Object

Class encapsulating the id used for TraceIds.

It contains parsing and formatting to string for both decimal and hexadecimal representations. The string representations are either kept from parsing, or generated on demand and cached.

Field Summary

Fields

Modifier and Type	Field	Description
static final DDTraceId	ONE	Convenience constant used from tests
static final DDTraceId	ZERO	Invalid TraceId value used to denote no TraceId.

Constructor Summary

Constructors

Constructor	Description
DDTraceId()

Method Summary

Modifier and Type	Method	Description
static DDTraceId	from(long id)	Creates a new 64-bit TraceId from the given long interpreted as the bits of the unsigned 64-bit id.
static DDTraceId	from(String s)	Creates a new 64-bit TraceId from the given String representation.
static DDTraceId	fromHex(String s)	Creates a new DDTraceId from the given hexadecimal representation.
abstract String	toHexString()	Returns the lower-case zero-padded 32 hexadecimal characters String representation of the DDTraceId.
abstract String	toHexStringPadded(int size)	Returns the lower-case zero-padded hexadecimal String representation of the DDTraceId.
abstract long	toHighOrderLong()	Returns the high-order 64 bits of 128-bit DDTraceId as un unsigned long.
abstract long	toLong()	Returns the low-order 64 bits of the DDTraceId as an unsigned long.
abstract String	toString()	Returns a 64-bit only decimal String representation of the DDTraceId.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

ZERO

public static final DDTraceId ZERO

Invalid TraceId value used to denote no TraceId.

ONE

public static final DDTraceId ONE

Convenience constant used from tests

Constructor Details

DDTraceId

public DDTraceId()

Method Details

from

public static DDTraceId from(long id)

Creates a new 64-bit TraceId from the given long interpreted as the bits of the unsigned 64-bit id. This means that values larger than Long.MAX_VALUE will be represented as negative numbers.

Parameters:

id - The long representing the bits of the unsigned 64-bit id.

Returns:

A new DDTraceId instance.

from

public static DDTraceId from(String s)
                      throws NumberFormatException

Creates a new 64-bit TraceId from the given String representation.

Parameters:

s - The String representation of a DDTraceId.

Returns:

A new DDTraceId instance.

Throws:

NumberFormatException - If the given String does not represent a valid number.

fromHex

public static DDTraceId fromHex(String s)
                         throws NumberFormatException

Creates a new DDTraceId from the given hexadecimal representation.

Parameters:

s - The hexadecimal String representation of a DD128bTraceId to parse.

Returns:

A new DDTraceId instance.

Throws:

NumberFormatException - If the given hexadecimal String does not represent a valid number.

toString

public abstract String toString()

Returns a 64-bit only decimal String representation of the DDTraceId. The String will be cached.

Overrides:

toString in class Object

Returns:

A cached 64-bit only decimal String representation of the DDTraceId instance.

toHexString

public abstract String toHexString()

Returns the lower-case zero-padded 32 hexadecimal characters String representation of the DDTraceId. The * String will be cached.

Returns:

A cached lower-case zero-padded 32 hexadecimal characters String representation of the DDTraceId instance.

toHexStringPadded

public abstract String toHexStringPadded(int size)

Returns the lower-case zero-padded hexadecimal String representation of the DDTraceId. The size will be rounded up to 16 or 32 characters. This hexadecimal String will not be cached.

Parameters:

size - The size in characters of the zero-padded String (rounded up to 16 or 32).

Returns:

A lower-case zero-padded String representation representation of the DDTraceId instance.

toLong

public abstract long toLong()

Returns the low-order 64 bits of the DDTraceId as an unsigned long. This means that values larger than Long.MAX_VALUE will be represented as negative numbers.

Returns:

The low-order 64 bits of the DDTraceId as an unsigned long.

toHighOrderLong

public abstract long toHighOrderLong()

Returns the high-order 64 bits of 128-bit DDTraceId as un unsigned long. This means that values larger than Long.MAX_VALUE will be represented as negative numbers.

Returns:

The high-order 64 bits of the 128-bit DDTraceId as an unsigned long, 0 for 64-bit DDTraceId only.