TraceFlags (opentelemetry-api 0.6.0 API)

java.lang.Object
- io.opentelemetry.trace.TraceFlags

```
@Immutable
public final class TraceFlags
extends Object
```
A class that represents global trace options. These options are propagated to all child spans. These determine features such as whether a Span should be traced. It is implemented as a bitmask.

Since:

0.1.0

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TraceFlags.Builder
Builder class for TraceFlags.

Nested Classes
Modifier and Type	Class and Description
`static class`	`TraceFlags.Builder` Builder class for `TraceFlags`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static TraceFlags.Builder`	`builder()` Returns a new `TraceFlags.Builder` with default options.
`static TraceFlags.Builder`	`builder(TraceFlags traceFlags)` Returns a new `TraceFlags.Builder` with all given options set.
`void`	`copyBytesTo(byte[] dest, int destOffset)` Copies the byte representations of the `TraceFlags` into the `dest` beginning at the `destOffset` offset.
`void`	`copyLowerBase16To(char[] dest, int destOffset)` Copies the lowercase base16 representations of the `TraceId` into the `dest` beginning at the `destOffset` offset.
`boolean`	`equals(Object obj)`
`static TraceFlags`	`fromByte(byte src)` Returns a `TraceFlags` whose representation is `src`.
`static TraceFlags`	`fromLowerBase16(CharSequence src, int srcOffset)` Returns a `TraceOption` built from a lowercase base16 representation.
`byte`	`getByte()` Returns the one byte representation of the `TraceFlags`.
`static TraceFlags`	`getDefault()` Returns the default `TraceFlags`.
`static int`	`getSize()` Returns the size in bytes of the `TraceFlags`.
`int`	`hashCode()`
`boolean`	`isSampled()` Returns a boolean indicating whether this `Span` is part of a sampled trace and data should be exported to a persistent store.
`String`	`toLowerBase16()` Returns the lowercase base16 encoding of this `TraceFlags`.
`String`	`toString()`

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

- Method Detail
  - getSize
```
public static int getSize()
```
    Returns the size in bytes of the TraceFlags.
    
    Returns:
    
    the size in bytes of the TraceFlags.
    
    Since:
    
    0.1.0
  - getDefault
```
public static TraceFlags getDefault()
```
    Returns the default TraceFlags.
    
    Returns:
    
    the default TraceFlags.
    
    Since:
    
    0.1.0
  - fromByte
```
public static TraceFlags fromByte(byte src)
```
    Returns a TraceFlags whose representation is src.
    
    Parameters:
    
    src - the byte representation of the TraceFlags.
    
    Returns:
    
    a TraceFlags whose representation is src.
    
    Since:
    
    0.1.0
  - fromLowerBase16
```
public static TraceFlags fromLowerBase16(CharSequence src,
                                         int srcOffset)
```
    Returns a TraceOption built from a lowercase base16 representation.
    
    Parameters:
    
    src - the lowercase base16 representation.
    
    srcOffset - the offset in the buffer where the representation of the TraceFlags begins.
    
    Returns:
    
    a TraceOption built from a lowercase base16 representation.
    
    Throws:
    
    NullPointerException - if src is null.
    
    IllegalArgumentException - if src.length is not 2 * TraceOption.SIZE OR if the str has invalid characters.
    
    Since:
    
    0.1.0
  - getByte
```
public byte getByte()
```
    Returns the one byte representation of the TraceFlags.
    
    Returns:
    
    the one byte representation of the TraceFlags.
    
    Since:
    
    0.1.0
  - copyBytesTo
```
public void copyBytesTo(byte[] dest,
                        int destOffset)
```
    Copies the byte representations of the TraceFlags into the dest beginning at the destOffset offset.
    Equivalent with (but faster because it avoids any new allocations):
```
 System.arraycopy(getBytes(), 0, dest, destOffset, TraceFlags.getSize());
 
```
    Parameters:
    
    dest - the destination buffer.
    
    destOffset - the starting offset in the destination buffer.
    
    Throws:
    
    NullPointerException - if dest is null.
    
    IndexOutOfBoundsException - if destOffset+TraceFlags.getSize() is greater than dest.length.
    
    Since:
    
    0.1.0
  - copyLowerBase16To
```
public void copyLowerBase16To(char[] dest,
                              int destOffset)
```
    Copies the lowercase base16 representations of the TraceId into the dest beginning at the destOffset offset.
    
    Parameters:
    
    dest - the destination buffer.
    
    destOffset - the starting offset in the destination buffer.
    
    Throws:
    
    IndexOutOfBoundsException - if destOffset + 2 is greater than dest.length.
    
    Since:
    
    0.1.0
  - toLowerBase16
```
public String toLowerBase16()
```
    Returns the lowercase base16 encoding of this TraceFlags.
    
    Returns:
    
    the lowercase base16 encoding of this TraceFlags.
    
    Since:
    
    0.1.0
  - builder
```
public static TraceFlags.Builder builder()
```
    Returns a new TraceFlags.Builder with default options.
    
    Returns:
    
    a new Builder with default options.
    
    Since:
    
    0.1.0
  - builder
```
public static TraceFlags.Builder builder(TraceFlags traceFlags)
```
    Returns a new TraceFlags.Builder with all given options set.
    
    Parameters:
    
    traceFlags - the given options set.
    
    Returns:
    
    a new Builder with all given options set.
    
    Since:
    
    0.1.0
  - isSampled
```
public boolean isSampled()
```
    Returns a boolean indicating whether this Span is part of a sampled trace and data should be exported to a persistent store.
    
    Returns:
    
    a boolean indicating whether the trace is sampled.
    
    Since:
    
    0.1.0
  - equals
```
public boolean equals(@Nullable
                      Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class TraceFlags

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getSize

getDefault

fromByte

fromLowerBase16

getByte

copyBytesTo

copyLowerBase16To

toLowerBase16

builder

builder

isSampled

equals

hashCode

toString