openconsensus.trace

Class Event

java.lang.Object

openconsensus.trace.Event

@Immutable
public abstract class Event
extends Object

A text annotation with a set of attributes.

Since:

0.1.0

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Event() Protected constructor to allow subclassing this class.

Method Summary

Modifier and Type	Method and Description
static Event	create(String name) Returns a new Event with the given name.
static Event	create(String name, Map<String,AttributeValue> attributes) Returns a new Event with the given name and set of attributes.
abstract Map<String,AttributeValue>	getAttributes() Return the attributes of the Event.
abstract String	getName() Return the name of the Event.

Methods inherited from class java.lang.Object

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

Constructor Detail

Event

protected Event()

Protected constructor to allow subclassing this class.

Method Detail

getName

public abstract String getName()

Return the name of the Event.

Returns:

the name of the Event.

Since:

0.1.0

getAttributes

public abstract Map<String,AttributeValue> getAttributes()

Return the attributes of the Event.

Returns:

the attributes of the Event.

Since:

0.1.0

create

public static Event create(String name)

Returns a new Event with the given name.

Parameters:

name - the text name of the Event.

Returns:

a new Event with the given name.

Throws:

NullPointerException - if name is null.

Since:

0.1.0

create

public static Event create(String name,
                           Map<String,AttributeValue> attributes)

Returns a new Event with the given name and set of attributes.

Parameters:

name - the text name of the Event.

attributes - the attributes of the Event.

Returns:

a new Event with the given name and set of attributes.

Throws:

NullPointerException - if name or attributes are null.

Since:

0.1.0