io.opencensus.trace

Class Annotation

java.lang.Object

io.opencensus.trace.Annotation

@Immutable
public abstract class Annotation
extends Object

A text annotation with a set of attributes.

Since:

0.5

Method Summary

Modifier and Type	Method and Description
static Annotation	fromDescription(String description) Returns a new Annotation with the given description.
static Annotation	fromDescriptionAndAttributes(String description, Map<String,AttributeValue> attributes) Returns a new Annotation with the given description and set of attributes.
abstract Map<String,AttributeValue>	getAttributes() Return the attributes of the Annotation.
abstract String	getDescription() Return the description of the Annotation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

fromDescription

public static Annotation fromDescription(String description)

Returns a new Annotation with the given description.

Parameters:

description - the text description of the Annotation.

Returns:

a new Annotation with the given description.

Throws:

NullPointerException - if description is null.

Since:

0.5

fromDescriptionAndAttributes

public static Annotation fromDescriptionAndAttributes(String description,
                                                      Map<String,AttributeValue> attributes)

Returns a new Annotation with the given description and set of attributes.

Parameters:

description - the text description of the Annotation.

attributes - the attributes of the Annotation.

Returns:

a new Annotation with the given description and set of attributes.

Throws:

NullPointerException - if description or attributes are null.

Since:

0.5

getDescription

public abstract String getDescription()

Return the description of the Annotation.

Returns:

the description of the Annotation.

Since:

0.5

getAttributes

public abstract Map<String,AttributeValue> getAttributes()

Return the attributes of the Annotation.

Returns:

the attributes of the Annotation.

Since:

0.5