datadog.trace.api

Class DDId

java.lang.Object

datadog.trace.api.DDId

public class DDId
extends Object

Class encapsulating the unsigned 64 bit id used for Trace and Span ids.

It contains generation of new ids, parsing, and to string for both decimal and hex representations. The decimal string representation is either kept from parsing, or generated on demand and cached.

Field Summary

Fields

Modifier and Type	Field and Description
static DDId	MAX
static DDId	ZERO

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
static DDId	from(long id) Create a new DDId from the given long interpreted as the bits of the unsigned 64 bit id.
static DDId	from(String s) Create a new DDId from the given String representation of the unsigned 64 bit id.
static DDId	fromHex(String s) Create a new DDId from the given String hex representation of the unsigned 64 bit id.
static DDId	fromHexTruncatedWithOriginal(String s) Create a new DDId from the given String hex representation of the unsigned 64 bit (or more) id truncated to 64 bits, while retaining the original String representation for use in headers.
static DDId	fromHexWithOriginal(String s) Create a new DDId from the given String hex representation of the unsigned 64 bit id, while retalining the original String representation for use in headers.
int	hashCode()
String	toHexString() Returns the no zero padded hex representation, in lower case, of the unsigned 64 bit id.
String	toHexStringOrOriginal() Returns the no zero padded hex representation, in lower case, of the unsigned 64 bit id, or the original String used to create this DDId.
String	toHexStringPadded(int size) Returns the zero padded hex representation, in lower case, of the unsigned 64 bit id.
long	toLong() Returns the id as a long representing the bits of the unsigned 64 bit id.
String	toString() Returns the decimal string representation of the unsigned 64 bit id.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

ZERO

public static final DDId ZERO

MAX

public static final DDId MAX

Method Detail

from

public static DDId from(long id)

Create a new DDId 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 - long representing the bits of the unsigned 64 bit id

Returns:

DDId

from

public static DDId from(String s)
                 throws NumberFormatException

Create a new DDId from the given String representation of the unsigned 64 bit id.

Parameters:

s - String of unsigned 64 bit id

Returns:

DDId

Throws:

NumberFormatException

fromHex

public static DDId fromHex(String s)
                    throws NumberFormatException

Create a new DDId from the given String hex representation of the unsigned 64 bit id.

Parameters:

s - String in hex of unsigned 64 bit id

Returns:

DDId

Throws:

NumberFormatException

fromHexWithOriginal

public static DDId fromHexWithOriginal(String s)
                                throws NumberFormatException

Create a new DDId from the given String hex representation of the unsigned 64 bit id, while retalining the original String representation for use in headers.

Parameters:

s - String in hex of unsigned 64 bit id

Returns:

DDId

Throws:

NumberFormatException

fromHexTruncatedWithOriginal

public static DDId fromHexTruncatedWithOriginal(String s)
                                         throws NumberFormatException

Create a new DDId from the given String hex representation of the unsigned 64 bit (or more) id truncated to 64 bits, while retaining the original String representation for use in headers.

Parameters:

s - String in hex of unsigned 64 bit (or more) id

Returns:

DDId

Throws:

NumberFormatException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Returns the decimal string representation of the unsigned 64 bit id. The String will be cached.

Overrides:

toString in class Object

Returns:

decimal string

toHexString

public String toHexString()

Returns the no zero padded hex representation, in lower case, of the unsigned 64 bit id. The hex String will NOT be cached.

Returns:

non zero padded hex String

toHexStringPadded

public String toHexStringPadded(int size)

Returns the zero padded hex representation, in lower case, of the unsigned 64 bit id. The size will be rounded up to 16 or 32 characters. The hex String will NOT be cached.

Parameters:

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

Returns:

zero padded hex String

toHexStringOrOriginal

public String toHexStringOrOriginal()

Returns the no zero padded hex representation, in lower case, of the unsigned 64 bit id, or the original String used to create this DDId. The hex String will NOT be cached.

Returns:

non zero padded hex String

toLong

public long toLong()

Returns the id as a long representing the bits of the unsigned 64 bit id. This means that values larger than Long.MAX_VALUE will be represented as negative numbers.

Returns:

long value representing the bits of the unsigned 64 bit id.