io.opentracing.propagation

Class TextMapExtractAdapter

java.lang.Object

io.opentracing.propagation.TextMapExtractAdapter

All Implemented Interfaces:

TextMap, Iterable<Map.Entry<String,String>>

public final class TextMapExtractAdapter
extends Object
implements TextMap

A TextMap carrier for use with Tracer.extract() ONLY (it has no mutating methods). Note that the TextMap interface can be made to wrap around arbitrary data types (not just Map as illustrated here).

See Also:

Tracer.extract(Format, Object)

Constructor Summary

Constructors

Constructor and Description
TextMapExtractAdapter(Map<String,String> map)

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 class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

TextMapExtractAdapter

public TextMapExtractAdapter(Map<String,String> map)

Method Detail

iterator

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

Description copied from interface: TextMap

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

Specified by:

iterator in interface TextMap

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

public void put(String key,
                String value)

Description copied from interface: TextMap

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

Specified by:

put in interface TextMap

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