Class TextFormat.NoopTextFormat

java.lang.Object

io.opencensus.trace.propagation.TextFormat

io.opencensus.trace.propagation.TextFormat.NoopTextFormat

Enclosing class:

TextFormat

private static final class TextFormat.NoopTextFormat
extends TextFormat

Since:

0.11

Nested Class Summary

Nested classes/interfaces inherited from class TextFormat

TextFormat.Getter<C>, TextFormat.Setter<C>

Constructor Summary

Constructors

Modifier	Constructor	Description
private	NoopTextFormat()

Method Summary

Modifier and Type	Method	Description
<C> SpanContext	extract(C carrier, TextFormat.Getter<C> getter)	Extracts the span context from upstream.
List<String>	fields()	The propagation fields defined.
<C> void	inject(SpanContext spanContext, C carrier, TextFormat.Setter<C> setter)	Injects the span context downstream.

Methods inherited from class TextFormat

getNoopTextFormat

Methods inherited from class Object

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

Constructor Details

NoopTextFormat

private NoopTextFormat()

Method Details

fields

public List<String> fields()

Description copied from class: TextFormat

The propagation fields defined. If your carrier is reused, you should delete the fields here before calling TextFormat.inject(SpanContext, Object, Setter).

For example, if the carrier is a single-use or immutable request object, you don't need to clear fields as they couldn't have been set before. If it is a mutable, retryable object, successive calls should clear these fields first.

Specified by:

fields in class TextFormat

inject

public <C> void inject(SpanContext spanContext,
 C carrier,
 TextFormat.Setter<C> setter)

Description copied from class: TextFormat

Injects the span context downstream. For example, as http headers.

Specified by:

inject in class TextFormat

Parameters:

spanContext - possibly not sampled.

carrier - holds propagation fields. For example, an outgoing message or http request.

setter - invoked for each propagation key to add or remove.

extract

public <C> SpanContext extract(C carrier,
 TextFormat.Getter<C> getter)

Description copied from class: TextFormat

Extracts the span context from upstream. For example, as http headers.

Specified by:

extract in class TextFormat

Parameters:

carrier - holds propagation fields. For example, an outgoing message or http request.

getter - invoked for each propagation key to get.