io.opentracing.propagation.TextMapWriter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opentracing-api Show documentation

OpenTracing Java API

There is a newer version: 0.33.0

/**
 * Copyright 2016 The OpenTracing Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
package io.opentracing.propagation;

/**
 * TextMapWriter is a built-in carrier for Tracer.inject(). TextMapWriter implementations allows Tracers to write key:value String pairs into arbitrary data structures.
 *
 * @see io.opentracing.Tracer#inject(io.opentracing.SpanContext, Object)
 */
public interface TextMapWriter {
    /**
     * Puts a key:value pair into the TextMapWriter's backing store.
     *
     * @param key an arbitrary string (unlike HttpHeaderWriter, there are no HTTP-style constraints on the contents)
     * @param value an arbitrary string
     *
     * @see io.opentracing.Tracer#inject(io.opentracing.SpanContext, Object)
     * @see io.opentracing.propagation.HttpHeaderWriter
     */
    void put(String key, String value);
}