java.lang.Object
- brave.propagation.TraceContextOrSamplingFlags

```
public final class TraceContextOrSamplingFlags
extends Object
```
Union type that contains only one of trace context, trace ID context or sampling flags. This type is designed for use with Tracer.nextSpan(TraceContextOrSamplingFlags).
Users should not create instances of this, rather use TraceContext.Extractor provided by a Propagation implementation such as Propagation.B3_STRING.
Those implementing Propagation should use the following advice:
```
   If you have the trace and span ID, use create(TraceContext)
   If you have only a trace ID, use create(TraceIdContext)
   Otherwise, use create(SamplingFlags)
 
```
If your propagation implementation needs additional state, append it via TraceContextOrSamplingFlags.Builder.addExtra(Object).
This started as a port of com.github.kristofa.brave.TraceData, which served the same purpose.
Since:

4.0

See Also:

TraceContext.Extractor

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class TraceContextOrSamplingFlags.Builder

Field Summary

Fields
Modifier and Type	Field	Description
`static TraceContextOrSamplingFlags`	`DEBUG`
`static TraceContextOrSamplingFlags`	`EMPTY`
`static TraceContextOrSamplingFlags`	`NOT_SAMPLED`
`static TraceContextOrSamplingFlags`	`SAMPLED`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`TraceContext`	`context()`	Returns non-`null` when both a trace ID and span ID were `extracted` from a request.
`static TraceContextOrSamplingFlags`	`create(SamplingFlags flags)`	Used to implement `TraceContext.Extractor.extract(Object)` when the format allows extracting only sampling flags.
`static TraceContextOrSamplingFlags`	`create(TraceContext context)`	Used to implement `TraceContext.Extractor.extract(Object)` for a format that can extract a complete `TraceContext`, including a trace ID and span ID.
`static TraceContextOrSamplingFlags`	`create(TraceIdContext traceIdContext)`	Used to implement `TraceContext.Extractor.extract(Object)` when the format allows extracting a trace ID without a span ID
`static TraceContextOrSamplingFlags`	`create(Boolean sampled, boolean debug)`	Deprecated. Since 5.12, use constants defined on this type as needed.
`boolean`	`equals(Object o)`
`List<Object>`	`extra()`	Returns a list of additional state extracted from the request.
`int`	`hashCode()`
`static TraceContextOrSamplingFlags.Builder`	`newBuilder()`	Deprecated. Since 5.12, use `newBuilder(TraceContext)`, `newBuilder(TraceIdContext)` or `newBuilder(SamplingFlags)`.
`static TraceContextOrSamplingFlags.Builder`	`newBuilder(SamplingFlags flags)`	Use when implementing `TraceContext.Extractor.extract(Object)` requires `TraceContextOrSamplingFlags.Builder.sampledLocal()` or `TraceContextOrSamplingFlags.Builder.addExtra(Object)`.
`static TraceContextOrSamplingFlags.Builder`	`newBuilder(TraceContext context)`	Use when implementing `TraceContext.Extractor.extract(Object)` requires `TraceContextOrSamplingFlags.Builder.sampledLocal()` or `TraceContextOrSamplingFlags.Builder.addExtra(Object)`.
`static TraceContextOrSamplingFlags.Builder`	`newBuilder(TraceIdContext traceIdContext)`	Use when implementing `TraceContext.Extractor.extract(Object)` requires `TraceContextOrSamplingFlags.Builder.sampledLocal()` or `TraceContextOrSamplingFlags.Builder.addExtra(Object)`.
`Boolean`	`sampled()`	Returns `SamplingFlags.sampled()`, regardless of subtype.
`TraceContextOrSamplingFlags`	`sampled(boolean sampled)`	This is used to apply a `SamplerFunction` decision with least overhead.
`TraceContextOrSamplingFlags`	`sampled(Boolean sampled)`	Deprecated. do not use object variant..
`boolean`	`sampledLocal()`	Returns `SamplingFlags.sampledLocal()`, regardless of subtype.
`SamplingFlags`	`samplingFlags()`	Returns non-`null` when a trace ID was not `extracted` from a request.
`TraceContextOrSamplingFlags.Builder`	`toBuilder()`	Use to decorate an `extraction result` with `sampledLocal()` or additional `extra()`.
`String`	`toString()`
`TraceIdContext`	`traceIdContext()`	Returns non-`null` when a trace ID was `extracted` from a request, but a span ID was not.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - EMPTY
```
public static final TraceContextOrSamplingFlags EMPTY
```
  - NOT_SAMPLED
```
public static final TraceContextOrSamplingFlags NOT_SAMPLED
```
  - SAMPLED
```
public static final TraceContextOrSamplingFlags SAMPLED
```
  - DEBUG
```
public static final TraceContextOrSamplingFlags DEBUG
```
- Method Detail
  - create
```
public static TraceContextOrSamplingFlags create(TraceContext context)
```
    Used to implement TraceContext.Extractor.extract(Object) for a format that can extract a complete TraceContext, including a trace ID and span ID.
    
    Since:
    
    4.3
    
    See Also:
    
    context(), newBuilder(TraceContext), TraceContext.Extractor.extract(Object)
  - create
```
public static TraceContextOrSamplingFlags create(TraceIdContext traceIdContext)
```
    Used to implement TraceContext.Extractor.extract(Object) when the format allows extracting a trace ID without a span ID
    
    Since:
    
    4.9
    
    See Also:
    
    traceIdContext(), newBuilder(TraceIdContext), TraceContext.Extractor.extract(Object)
  - create
```
public static TraceContextOrSamplingFlags create(SamplingFlags flags)
```
    Used to implement TraceContext.Extractor.extract(Object) when the format allows extracting only sampling flags.
    
    Since:
    
    4.3
    
    See Also:
    
    samplingFlags(), newBuilder(TraceIdContext), TraceContext.Extractor.extract(Object)
  - newBuilder
```
public static TraceContextOrSamplingFlags.Builder newBuilder(TraceContext context)
```
    Use when implementing TraceContext.Extractor.extract(Object) requires TraceContextOrSamplingFlags.Builder.sampledLocal() or TraceContextOrSamplingFlags.Builder.addExtra(Object). Otherwise, use create(TraceContext) as it is more efficient.
    
    Since:
    
    5.12
    
    See Also:
    
    create(TraceContext), TraceContext.Extractor.extract(Object)
  - newBuilder
```
public static TraceContextOrSamplingFlags.Builder newBuilder(TraceIdContext traceIdContext)
```
    Use when implementing TraceContext.Extractor.extract(Object) requires TraceContextOrSamplingFlags.Builder.sampledLocal() or TraceContextOrSamplingFlags.Builder.addExtra(Object). Otherwise, use create(TraceIdContext) as it is more efficient.
    
    Since:
    
    5.12
    
    See Also:
    
    create(TraceIdContext), TraceContext.Extractor.extract(Object)
  - newBuilder
```
public static TraceContextOrSamplingFlags.Builder newBuilder(SamplingFlags flags)
```
    Use when implementing TraceContext.Extractor.extract(Object) requires TraceContextOrSamplingFlags.Builder.sampledLocal() or TraceContextOrSamplingFlags.Builder.addExtra(Object). Otherwise, use create(SamplingFlags) as it is more efficient.
    
    Since:
    
    5.12
    
    See Also:
    
    create(SamplingFlags), TraceContext.Extractor.extract(Object)
  - newBuilder
```
@Deprecated
public static TraceContextOrSamplingFlags.Builder newBuilder()
```
    Deprecated.
    Since 5.12, use newBuilder(TraceContext), newBuilder(TraceIdContext) or newBuilder(SamplingFlags).
  - sampled
```
@Nullable
public Boolean sampled()
```
    Returns SamplingFlags.sampled(), regardless of subtype.
  - sampledLocal
```
public final boolean sampledLocal()
```
    Returns SamplingFlags.sampledLocal(), regardless of subtype.
  - sampled
```
@Deprecated
public TraceContextOrSamplingFlags sampled(@Nullable
                                           Boolean sampled)
```
    Deprecated.
    do not use object variant.. only set when you have a sampling decision
  - sampled
```
public TraceContextOrSamplingFlags sampled(boolean sampled)
```
    This is used to apply a SamplerFunction decision with least overhead. Ex.
    Boolean sampled = extracted.sampled(); // only recreate the context if the messaging sampler made a decision if (sampled == null && (sampled = sampler.trySample(request)) != null) { extracted = extracted.sampled(sampled.booleanValue()); }
    Parameters:
    
    sampled - decision to apply
    
    Returns:
    
    this unless sampled() differs from the input.
    
    Since:
    
    5.2
  - context
```
@Nullable
public TraceContext context()
```
    Returns non-null when both a trace ID and span ID were extracted from a request.
    For example, given the header "b3: 80f198ee56343ba864fe8b2a57d3eff7-e457b5a2e4d86bd1-1", B3Propagation extracts the following:
    
    TraceContext.traceIdString(): "80f198ee56343ba864fe8b2a57d3eff7"
    
    TraceContext.spanIdString(): "e457b5a2e4d86bd1"
    
    SamplingFlags.sampled(): true
    Returns:
    
    the trace context when traceIdContext() ()} and samplingFlags() are not null
    
    Since:
    
    4.0
    
    See Also:
    
    create(TraceContext), newBuilder(TraceContext)
  - traceIdContext
```
@Nullable
public TraceIdContext traceIdContext()
```
    Returns non-null when a trace ID was extracted from a request, but a span ID was not.
    For example, given the header "x-amzn-trace-id: Root=1-5759e988-bd862e3fe1be46a994272793", AWSPropagation extracts the following:
    
    TraceIdContext.traceIdString(): "15759e988bd862e3fe1be46a994272793"
    
    SamplingFlags.sampled(): null
    Returns:
    
    the trace ID context when context() and samplingFlags() are not null
    
    Since:
    
    4.9
    
    See Also:
    
    create(TraceIdContext), newBuilder(TraceIdContext)
  - samplingFlags
```
@Nullable
public SamplingFlags samplingFlags()
```
    Returns non-null when a trace ID was not extracted from a request.
    For example, given the header "b3: 1", B3Propagation extracts SAMPLED.
    
    Returns:
    
    sampling flags when context() and traceIdContext() are not null
    
    Since:
    
    4.9
    
    See Also:
    
    create(SamplingFlags), newBuilder(SamplingFlags)
  - extra
```
public final List<Object> extra()
```
    Returns a list of additional state extracted from the request. Will be non-empty when context() is null.
    
    Since:
    
    4.9
    
    See Also:
    
    TraceContext.extra()
  - toBuilder
```
public TraceContextOrSamplingFlags.Builder toBuilder()
```
    Use to decorate an extraction result with sampledLocal() or additional extra().
    
    Since:
    
    4.9
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - create
```
@Deprecated
public static TraceContextOrSamplingFlags create(@Nullable
                                                 Boolean sampled,
                                                 boolean debug)
```
    Deprecated.
    Since 5.12, use constants defined on this type as needed.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class TraceContextOrSamplingFlags

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY

NOT_SAMPLED

SAMPLED

DEBUG

Method Detail

create

create

create

newBuilder

newBuilder

newBuilder

newBuilder

sampled

sampledLocal

sampled

sampled

context

traceIdContext

samplingFlags

extra

toBuilder

toString

create

equals

hashCode