io.opentracing.propagation

Interface TextMap

All Superinterfaces:

Iterable<Map.Entry<String,String>>

All Known Implementing Classes:

TextMapExtractAdapter, TextMapInjectAdapter

public interface TextMap
extends Iterable<Map.Entry<String,String>>

TextMap is a built-in carrier for Tracer.inject() and Tracer.extract(). TextMap implementations allows Tracers to read and write key:value String pairs from arbitrary underlying sources of data.

See Also:

Tracer.inject(SpanContext, Format, Object), Tracer.extract(Format, Object)

Method Summary

Modifier and Type	Method and Description
Iterator<Map.Entry<String,String>>	iterator() Gets an iterator over arbitrary key:value pairs from the TextMapReader.
void	put(String key, String value) Puts a key:value pair into the TextMapWriter's backing store.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

iterator

Iterator<Map.Entry<String,String>> iterator()

Gets an iterator over arbitrary key:value pairs from the TextMapReader.

Specified by:

iterator in interface Iterable<Map.Entry<String,String>>

Returns:

entries in the TextMap backing store; note that for some Formats, the iterator may include entries that were never injected by a Tracer implementation (e.g., unrelated HTTP headers)

See Also:

Tracer.extract(Format, Object), Format.Builtin.TEXT_MAP, Format.Builtin.HTTP_HEADERS

put

void put(String key,
         String value)

Puts a key:value pair into the TextMapWriter's backing store.

Parameters:

key - a String, possibly with constraints dictated by the particular Format this TextMap is paired with

value - a String, possibly with constraints dictated by the particular Format this TextMap is paired with

See Also:

Tracer.inject(io.opentracing.SpanContext, Format, Object), Format.Builtin.TEXT_MAP, Format.Builtin.HTTP_HEADERS