blob: f4268968b8864f4a8c58c8899d33571319882861 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
/*
* Copyright 2017, OpenCensus 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.opencensus.tags;
import io.opencensus.common.Scope;
/**
* Builder for the {@link TagContext} class.
*
* @since 0.8
*/
public abstract class TagContextBuilder {
/**
* Adds the key/value pair regardless of whether the key is present.
*
* @param key the {@code TagKey} which will be set.
* @param value the {@code TagValue} to set for the given key.
* @return this
* @since 0.8
*/
public abstract TagContextBuilder put(TagKey key, TagValue value);
/**
* Removes the key if it exists.
*
* @param key the {@code TagKey} which will be removed.
* @return this
* @since 0.8
*/
public abstract TagContextBuilder remove(TagKey key);
/**
* Creates a {@code TagContext} from this builder.
*
* @return a {@code TagContext} with the same tags as this builder.
* @since 0.8
*/
public abstract TagContext build();
/**
* Enters the scope of code where the {@link 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.
*
* @return an object that defines a scope where the {@code TagContext} created from this builder
* is set to the current context.
* @since 0.8
*/
public abstract Scope buildScoped();
}
|
