io.opencensus.trace

Class TraceOptions

java.lang.Object

io.opencensus.trace.TraceOptions

@Immutable
public final class TraceOptions
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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TraceOptions.Builder Builder class for TraceOptions.

Field Summary

Fields

Modifier and Type	Field and Description
static TraceOptions	DEFAULT The default TraceOptions.
static int	SIZE The size in bytes of the TraceOptions.

Method Summary

Modifier and Type	Method and Description
static TraceOptions.Builder	builder() Returns a new TraceOptions.Builder with default options.
static TraceOptions.Builder	builder(TraceOptions traceOptions) Returns a new TraceOptions.Builder with all given options set.
void	copyBytesTo(byte[] dest, int destOffset) Copies the byte representations of the TraceOptions into the dest beginning at the destOffset offset.
boolean	equals(Object obj)
static TraceOptions	fromBytes(byte[] buffer) Returns a TraceOptions built from a byte representation.
static TraceOptions	fromBytes(byte[] src, int srcOffset) Returns a TraceOptions whose representation is copied from the src beginning at the srcOffset offset.
byte[]	getBytes() Returns the 1-byte array representation of the TraceOptions.
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	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SIZE

public static final int SIZE

The size in bytes of the TraceOptions.

See Also:

Constant Field Values

DEFAULT

public static final TraceOptions DEFAULT

The default TraceOptions.

Method Detail

fromBytes

public static TraceOptions fromBytes(byte[] buffer)

Returns a TraceOptions built from a byte representation.

Equivalent with:

 TraceOptions.fromBytes(buffer, 0);
 

Parameters:

buffer - the representation of the TraceOptions.

Returns:

a TraceOptions whose representation is given by the buffer parameter.

Throws:

NullPointerException - if buffer is null.

IllegalArgumentException - if buffer.length is not SIZE.

fromBytes

public static TraceOptions fromBytes(byte[] src,
                                     int srcOffset)

Returns a TraceOptions whose representation is copied from the src beginning at the srcOffset offset.

Parameters:

src - the buffer where the representation of the TraceOptions is copied.

srcOffset - the offset in the buffer where the representation of the TraceOptions begins.

Returns:

a TraceOptions whose representation is copied from the buffer.

Throws:

NullPointerException - if src is null.

IndexOutOfBoundsException - if srcOffset+TraceOptions.SIZE is greater than src.length.

getBytes

public byte[] getBytes()

Returns the 1-byte array representation of the TraceOptions.

Returns:

the 1-byte array representation of the TraceOptions.

copyBytesTo

public void copyBytesTo(byte[] dest,
                        int destOffset)

Copies the byte representations of the TraceOptions into the dest beginning at the destOffset offset.

Equivalent with (but faster because it avoids any new allocations):

 System.arraycopy(getBytes(), 0, dest, destOffset, TraceOptions.SIZE);
 

Parameters:

dest - the destination buffer.

destOffset - the starting offset in the destination buffer.

Throws:

NullPointerException - if dest is null.

IndexOutOfBoundsException - if destOffset+TraceOptions.SIZE is greater than dest.length.

builder

public static TraceOptions.Builder builder()

Returns a new TraceOptions.Builder with default options.

Returns:

a new Builder with default options.

builder

public static TraceOptions.Builder builder(TraceOptions traceOptions)

Returns a new TraceOptions.Builder with all given options set.

Parameters:

traceOptions - the given options set.

Returns:

a new Builder with all given options set.

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.

equals

public boolean equals(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