io.opentelemetry.common

Class Attributes

java.lang.Object

io.opentelemetry.common.Attributes

All Implemented Interfaces:

ReadableAttributes, ReadableKeyValuePairs<AttributeValue>

@Immutable
public abstract class Attributes
extends Object
implements ReadableAttributes

An immutable container for attributes.

The keys are Strings and the values are AttributeValue instances.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Attributes.Builder Enables the creation of an Attributes instance with an arbitrary number of key-value pairs.

Nested classes/interfaces inherited from interface io.opentelemetry.common.ReadableKeyValuePairs

ReadableKeyValuePairs.KeyValueConsumer<V>

Constructor Summary

Constructors

Constructor and Description
Attributes()

Method Summary

Modifier and Type	Method and Description
static Attributes	empty() Returns a Attributes instance with no attributes.
void	forEach(ReadableKeyValuePairs.KeyValueConsumer<V> consumer) Iterates over all the key-value pairs of attributes contained by this instance.
V	get(String key) Returns the value of the given key, or null if the key does not exist.
boolean	isEmpty() Whether there are any attributes contained in this.
static Attributes.Builder	newBuilder() Creates a new Attributes.Builder instance for creating arbitrary Attributes.
static Attributes	of(String key, AttributeValue value) Returns a Attributes instance with a single key-value pair.
static Attributes	of(String key1, AttributeValue value1, String key2, AttributeValue value2) Returns a Attributes instance with two key-value pairs.
static Attributes	of(String key1, AttributeValue value1, String key2, AttributeValue value2, String key3, AttributeValue value3) Returns a Attributes instance with three key-value pairs.
static Attributes	of(String key1, AttributeValue value1, String key2, AttributeValue value2, String key3, AttributeValue value3, String key4, AttributeValue value4) Returns a Attributes instance with four key-value pairs.
static Attributes	of(String key1, AttributeValue value1, String key2, AttributeValue value2, String key3, AttributeValue value3, String key4, AttributeValue value4, String key5, AttributeValue value5) Returns a Attributes instance with five key-value pairs.
int	size() The number of attributes contained in this.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.opentelemetry.common.ReadableKeyValuePairs

forEach, get, isEmpty, size

Constructor Detail

Attributes

public Attributes()

Method Detail

empty

public static Attributes empty()

Returns a Attributes instance with no attributes.

of

public static Attributes of(String key,
                            AttributeValue value)

Returns a Attributes instance with a single key-value pair.

of

public static Attributes of(String key1,
                            AttributeValue value1,
                            String key2,
                            AttributeValue value2)

Returns a Attributes instance with two key-value pairs. Order of the keys is not preserved. Duplicate keys will be removed.

of

public static Attributes of(String key1,
                            AttributeValue value1,
                            String key2,
                            AttributeValue value2,
                            String key3,
                            AttributeValue value3)

Returns a Attributes instance with three key-value pairs. Order of the keys is not preserved. Duplicate keys will be removed.

of

public static Attributes of(String key1,
                            AttributeValue value1,
                            String key2,
                            AttributeValue value2,
                            String key3,
                            AttributeValue value3,
                            String key4,
                            AttributeValue value4)

Returns a Attributes instance with four key-value pairs. Order of the keys is not preserved. Duplicate keys will be removed.

of

public static Attributes of(String key1,
                            AttributeValue value1,
                            String key2,
                            AttributeValue value2,
                            String key3,
                            AttributeValue value3,
                            String key4,
                            AttributeValue value4,
                            String key5,
                            AttributeValue value5)

Returns a Attributes instance with five key-value pairs. Order of the keys is not preserved. Duplicate keys will be removed.

newBuilder

public static Attributes.Builder newBuilder()

Creates a new Attributes.Builder instance for creating arbitrary Attributes.

size

public int size()

Description copied from interface: ReadableKeyValuePairs

The number of attributes contained in this.

Specified by:

size in interface ReadableKeyValuePairs<V>

isEmpty

public boolean isEmpty()

Description copied from interface: ReadableKeyValuePairs

Whether there are any attributes contained in this.

Specified by:

isEmpty in interface ReadableKeyValuePairs<V>

forEach

public void forEach(ReadableKeyValuePairs.KeyValueConsumer<V> consumer)

Description copied from interface: ReadableKeyValuePairs

Iterates over all the key-value pairs of attributes contained by this instance.

Specified by:

forEach in interface ReadableKeyValuePairs<V>

get

@Nullable
public V get(String key)

Description copied from interface: ReadableKeyValuePairs

Returns the value of the given key, or null if the key does not exist.

Currently may be implemented via a linear search, depending on implementation, so O(n) performance in the worst case.

Specified by:

get in interface ReadableKeyValuePairs<V>

toString

public String toString()

Overrides:

toString in class Object