io.opentelemetry.correlationcontext

Class Entry

java.lang.Object

io.opentelemetry.correlationcontext.Entry

@Immutable
public abstract class Entry
extends Object

String-String key-value pair, along with EntryMetadata.

Since:

0.1.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_KEY_LENGTH The maximum length for an entry key name.
static int	MAX_VALUE_LENGTH The maximum length for a entry value.
static EntryMetadata	METADATA_UNLIMITED_PROPAGATION Default propagation metadata - unlimited propagation.

Method Summary

Modifier and Type	Method and Description
static Entry	create(String key, String value, EntryMetadata entryMetadata) Creates an Entry from the given key, value and metadata.
abstract EntryMetadata	getEntryMetadata() Returns the EntryMetadata associated with this Entry.
abstract String	getKey() Returns the entry's key.
abstract String	getValue() Returns the entry's value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAX_KEY_LENGTH

public static final int MAX_KEY_LENGTH

The maximum length for an entry key name. The value is 255.

Since:

0.1.0

See Also:

Constant Field Values

MAX_VALUE_LENGTH

public static final int MAX_VALUE_LENGTH

The maximum length for a entry value. The value is 255.

Since:

0.1.0

See Also:

Constant Field Values

METADATA_UNLIMITED_PROPAGATION

public static final EntryMetadata METADATA_UNLIMITED_PROPAGATION

Default propagation metadata - unlimited propagation.

Method Detail

create

public static Entry create(String key,
                           String value,
                           EntryMetadata entryMetadata)

Creates an Entry from the given key, value and metadata.

Parameters:

key - the entry key.

value - the entry value.

entryMetadata - the entry metadata.

Returns:

a Entry.

Since:

0.1.0

getKey

public abstract String getKey()

Returns the entry's key.

Returns:

the entry's key.

Since:

0.1.0

getValue

public abstract String getValue()

Returns the entry's value.

Returns:

the entry's value.

Since:

0.1.0

getEntryMetadata

public abstract EntryMetadata getEntryMetadata()

Returns the EntryMetadata associated with this Entry.

Returns:

the EntryMetadata.

Since:

0.1.0