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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
/*
* Copyright 2016-17, 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.trace;
import java.util.Arrays;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
/**
* A class that represents a span context. A span context contains the state that must propagate to
* child {@link Span}s and across process boundaries. It contains the identifiers (a {@link TraceId
* trace_id} and {@link SpanId span_id}) associated with the {@link Span} and a set of {@link
* TraceOptions options}.
*
* @since 0.5
*/
@Immutable
public final class SpanContext {
private final TraceId traceId;
private final SpanId spanId;
private final TraceOptions traceOptions;
/**
* The invalid {@code SpanContext}.
*
* @since 0.5
*/
public static final SpanContext INVALID =
new SpanContext(TraceId.INVALID, SpanId.INVALID, TraceOptions.DEFAULT);
/**
* Creates a new {@code SpanContext} with the given identifiers and options.
*
* @param traceId the trace identifier of the span context.
* @param spanId the span identifier of the span context.
* @param traceOptions the trace options for the span context.
* @return a new {@code SpanContext} with the given identifiers and options.
* @since 0.5
*/
public static SpanContext create(TraceId traceId, SpanId spanId, TraceOptions traceOptions) {
return new SpanContext(traceId, spanId, traceOptions);
}
/**
* Returns the trace identifier associated with this {@code SpanContext}.
*
* @return the trace identifier associated with this {@code SpanContext}.
* @since 0.5
*/
public TraceId getTraceId() {
return traceId;
}
/**
* Returns the span identifier associated with this {@code SpanContext}.
*
* @return the span identifier associated with this {@code SpanContext}.
* @since 0.5
*/
public SpanId getSpanId() {
return spanId;
}
/**
* Returns the trace options associated with this {@code SpanContext}.
*
* @return the trace options associated with this {@code SpanContext}.
* @since 0.5
*/
public TraceOptions getTraceOptions() {
return traceOptions;
}
/**
* Returns true if this {@code SpanContext} is valid.
*
* @return true if this {@code SpanContext} is valid.
* @since 0.5
*/
public boolean isValid() {
return traceId.isValid() && spanId.isValid();
}
@Override
public boolean equals(@Nullable Object obj) {
if (obj == this) {
return true;
}
if (!(obj instanceof SpanContext)) {
return false;
}
SpanContext that = (SpanContext) obj;
return traceId.equals(that.traceId)
&& spanId.equals(that.spanId)
&& traceOptions.equals(that.traceOptions);
}
@Override
public int hashCode() {
return Arrays.hashCode(new Object[] {traceId, spanId, traceOptions});
}
@Override
public String toString() {
return "SpanContext{traceId="
+ traceId
+ ", spanId="
+ spanId
+ ", traceOptions="
+ traceOptions
+ "}";
}
private SpanContext(TraceId traceId, SpanId spanId, TraceOptions traceOptions) {
this.traceId = traceId;
this.spanId = spanId;
this.traceOptions = traceOptions;
}
}
|
