Package io.opentelemetry.api.trace

Interface TraceStateBuilder

public interface TraceStateBuilder
A builder of TraceState. This implementation does full validation of the keys and values in the entries, and will ignore any entries that do not conform to the W3C specification.

  • Method Summary

    Modifier and Type
    Method
    Description
    TraceState
    build()
    Builds a TraceState by adding the entries to the parent in front of the key-value pairs list and removing duplicate entries.
    TraceStateBuilder
    put(String key, String value)
    Adds or updates the Entry that has the given key if it is present.
    TraceStateBuilder
    remove(String key)
    Removes the Entry that has the given key if it is present.

  • Method Details

    • put

      TraceStateBuilder put(String key, String value)
      Adds or updates the Entry that has the given key if it is present. The new Entry will always be added in the front of the list of entries.
      Parameters:
      key - the key for the Entry to be added.
      value - the value for the Entry to be added.
      Returns:
      this.

    • remove

      TraceStateBuilder remove(String key)
      Removes the Entry that has the given key if it is present.
      Parameters:
      key - the key for the Entry to be removed.
      Returns:
      this.

    • build

      TraceState build()
      Builds a TraceState by adding the entries to the parent in front of the key-value pairs list and removing duplicate entries.
      Returns:
      a TraceState with the new entries.