io.opencensus.tags

Class TagContextBuilder

java.lang.Object

io.opencensus.tags.TagContextBuilder

public abstract class TagContextBuilder
extends Object

Builder for the TagContext class.

Constructor Summary

Constructors

Constructor and Description
TagContextBuilder()

Method Summary

Modifier and Type	Method and Description
abstract TagContext	build() Creates a TagContext from this builder.
abstract Scope	buildScoped() Enters the scope of code where the TagContext created from this builder is in the current context and returns an object that represents that scope.
abstract TagContextBuilder	put(TagKey key, TagValue value) Adds the key/value pair regardless of whether the key is present.
abstract TagContextBuilder	remove(TagKey key) Removes the key if it exists.

Methods inherited from class java.lang.Object

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

Constructor Detail

TagContextBuilder

public TagContextBuilder()

Method Detail

put

public abstract TagContextBuilder put(TagKey key,
                                      TagValue value)

Adds the key/value pair regardless of whether the key is present.

Parameters:

key - the TagKey which will be set.

value - the TagValue to set for the given key.

Returns:

this

remove

public abstract TagContextBuilder remove(TagKey key)

Removes the key if it exists.

Parameters:

key - the TagKey which will be removed.

Returns:

this

build

public abstract TagContext build()

Creates a TagContext from this builder.

Returns:

a TagContext with the same tags as this builder.

buildScoped

public abstract Scope buildScoped()

Enters the scope of code where the TagContext created from this builder is in the current context and returns an object that represents that scope. The scope is exited when the returned object is closed.

Returns:

an object that defines a scope where the TagContext created from this builder is set to the current context.