io.opencensus.tags

Class Tagger

java.lang.Object

io.opencensus.tags.Tagger

public abstract class Tagger
extends Object

Object for creating new TagContexts and TagContexts based on the current context.

This class returns builders that can be used to create the implementation-dependent TagContexts.

Implementations may have different constraints and are free to convert tag contexts to their own subtypes. This means callers cannot assume the current context is the same instance as the one placed into scope.

Constructor Summary

Constructors

Constructor and Description
Tagger()

Method Summary

Modifier and Type	Method and Description
abstract TagContextBuilder	currentBuilder() Returns a new builder created from the current TagContext.
abstract TagContext	empty() Returns an empty TagContext.
abstract TagContextBuilder	emptyBuilder() Returns a new empty Builder.
abstract TagContext	getCurrentTagContext() Returns the current TagContext.
abstract TagContextBuilder	toBuilder(TagContext tags) Returns a builder based on this TagContext.
abstract Scope	withTagContext(TagContext tags) Enters the scope of code where the given TagContext is in the current context and returns an object that represents that scope.

Methods inherited from class java.lang.Object

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

Constructor Detail

Tagger

public Tagger()

Method Detail

empty

public abstract TagContext empty()

Returns an empty TagContext.

Returns:

an empty TagContext.

getCurrentTagContext

public abstract TagContext getCurrentTagContext()

Returns the current TagContext.

Returns:

the current TagContext.

emptyBuilder

public abstract TagContextBuilder emptyBuilder()

Returns a new empty Builder.

Returns:

a new empty Builder.

toBuilder

public abstract TagContextBuilder toBuilder(TagContext tags)

Returns a builder based on this TagContext.

Returns:

a builder based on this TagContext.

currentBuilder

public abstract TagContextBuilder currentBuilder()

Returns a new builder created from the current TagContext.

Returns:

a new builder created from the current TagContext.

withTagContext

public abstract Scope withTagContext(TagContext tags)

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

Parameters:

tags - the TagContext to be set to the current context.

Returns:

an object that defines a scope where the given TagContext is set to the current context.