Labels (opentelemetry-api 0.6.0 API)

java.lang.Object
- io.opentelemetry.common.Labels

All Implemented Interfaces:

ReadableKeyValuePairs<String>
```
@Immutable
public abstract class Labels
extends Object
```
An immutable container for labels, which are pairs of String.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Labels.Builder
Enables the creation of an Labels instance with an arbitrary number of key-value pairs.
- Nested classes/interfaces inherited from interface io.opentelemetry.common.ReadableKeyValuePairs
  ReadableKeyValuePairs.KeyValueConsumer<V>

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

Constructor Summary

Constructors
Constructor and Description

Labels()

Constructors
Constructor and Description
`Labels()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Labels`	`empty()` Returns a `Labels` 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 Labels.Builder`	`newBuilder()` Creates a new `Labels.Builder` instance for creating arbitrary `Labels`.
`static Labels`	`of(String[] keyValueLabelPairs)`
`static Labels`	`of(String key, String value)` Returns a `Labels` instance with a single key-value pair.
`static Labels`	`of(String key1, String value1, String key2, String value2)` Returns a `Labels` instance with two key-value pairs.
`static Labels`	`of(String key1, String value1, String key2, String value2, String key3, String value3)` Returns a `Labels` instance with three key-value pairs.
`static Labels`	`of(String key1, String value1, String key2, String value2, String key3, String value3, String key4, String value4)` Returns a `Labels` instance with four key-value pairs.
`static Labels`	`of(String key1, String value1, String key2, String value2, String key3, String value3, String key4, String value4, String key5, String value5)` Returns a `Labels` instance with five key-value pairs.
`int`	`size()` The number of attributes contained in this.

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

Constructor Detail
- Labels
```
public Labels()
```

Method Detail

empty
```
public static Labels empty()
```
Returns a Labels instance with no attributes.

of

public static Labels of(String key,
                        String value)

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

of

public static Labels of(String key1,
                        String value1,
                        String key2,
                        String value2)

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

of

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

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

of

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

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

of

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

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

of

public static Labels of(String[] keyValueLabelPairs)

newBuilder
```
public static Labels.Builder newBuilder()
```
Creates a new Labels.Builder instance for creating arbitrary Labels.

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>

Class Labels

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Labels

Method Detail

empty

of

of

of

of

of

of

newBuilder

size

isEmpty

forEach

get