io.opencensus.trace.SpanContext Maven / Gradle / Ivy
/*
* 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 com.google.guava4pingcap.base.MoreObjects;
import com.google.guava4pingcap.base.Objects;
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}.
*/
@Immutable
public final class SpanContext {
private final TraceId traceId;
private final SpanId spanId;
private final TraceOptions traceOptions;
/** The invalid {@code SpanContext}. */
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.
*/
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}.
*/
public TraceId getTraceId() {
return traceId;
}
/**
* Returns the span identifier associated with this {@code SpanContext}.
*
* @return the span identifier associated with this {@code SpanContext}.
*/
public SpanId getSpanId() {
return spanId;
}
/**
* Returns the trace options associated with this {@code SpanContext}.
*
* @return the trace options associated with this {@code SpanContext}.
*/
public TraceOptions getTraceOptions() {
return traceOptions;
}
/**
* Returns true if this {@code SpanContext} is valid.
*
* @return true if this {@code SpanContext} is valid.
*/
public boolean isValid() {
return traceId.isValid() && spanId.isValid();
}
@Override
public boolean equals(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 Objects.hashCode(traceId, spanId, traceOptions);
}
@Override
public String toString() {
return MoreObjects.toStringHelper(this)
.add("traceId", traceId)
.add("spanId", spanId)
.add("traceOptions", traceOptions)
.toString();
}
private SpanContext(TraceId traceId, SpanId spanId, TraceOptions traceOptions) {
this.traceId = traceId;
this.spanId = spanId;
this.traceOptions = traceOptions;
}
}