Class NoopTagMapBuilder

java.lang.Object

io.opencensus.tags.TagContextBuilder

io.opencensus.implcore.tags.NoopTagMapBuilder

final class NoopTagMapBuilder
extends TagContextBuilder

TagContextBuilder that is used when tagging is disabled.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final NoopTagMapBuilder	INSTANCE

Constructor Summary

Constructors

Modifier	Constructor	Description
private	NoopTagMapBuilder()

Method Summary

Modifier and Type	Method	Description
TagContext	build()	Creates a TagContext from this builder.
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.
TagContextBuilder	put(TagKey key, TagValue value)	Adds the key/value pair regardless of whether the key is present.
TagContextBuilder	put(TagKey key, TagValue value, TagMetadata tagMetadata)	Adds the key/value pair and metadata regardless of whether the key is present.
TagContextBuilder	remove(TagKey key)	Removes the key if it exists.

Methods inherited from class TagContextBuilder

putLocal, putPropagating

Methods inherited from class Object

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

Field Details

INSTANCE

static final NoopTagMapBuilder INSTANCE

Constructor Details

NoopTagMapBuilder

private NoopTagMapBuilder()

Method Details

put

public TagContextBuilder put(TagKey key,
 TagValue value)

Description copied from class: TagContextBuilder

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

For backwards-compatibility this method still produces propagating Tags.

Equivalent to calling put(key, value, TagMetadata.create(TagTtl.UNLIMITED_PROPAGATION)).

Specified by:

put in class TagContextBuilder

Parameters:

key - the TagKey which will be set.

value - the TagValue to set for the given key.

Returns:

this

put

public TagContextBuilder put(TagKey key,
 TagValue value,
 TagMetadata tagMetadata)

Description copied from class: TagContextBuilder

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

Overrides:

put in class TagContextBuilder

Parameters:

key - the TagKey which will be set.

value - the TagValue to set for the given key.

tagMetadata - the TagMetadata associated with this Tag.

Returns:

this

remove

public TagContextBuilder remove(TagKey key)

Description copied from class: TagContextBuilder

Removes the key if it exists.

Specified by:

remove in class TagContextBuilder

Parameters:

key - the TagKey which will be removed.

Returns:

this

build

public TagContext build()

Description copied from class: TagContextBuilder

Creates a TagContext from this builder.

Specified by:

build in class TagContextBuilder

Returns:

a TagContext with the same tags as this builder.

buildScoped

public Scope buildScoped()

Description copied from class: TagContextBuilder

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.

Specified by:

buildScoped in class TagContextBuilder

Returns:

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