org.apache.rocketmq.shaded.io.opentelemetry.api.common.Attributes Maven / Gradle / Ivy
/*
* Copyright The OpenTelemetry Authors
* SPDX-License-Identifier: Apache-2.0
*/
package org.apache.rocketmq.shaded.io.opentelemetry.api.common;
import static org.apache.rocketmq.shaded.io.opentelemetry.api.common.ArrayBackedAttributes.sortAndFilterToAttributes;
import java.util.Map;
import java.util.function.BiConsumer;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
/**
* An immutable container for attributes.
*
* The keys are {@link AttributeKey}s and the values are Object instances that match the type of
* the provided key.
*
*
Null keys will be silently dropped.
*
*
Note: The behavior of null-valued attributes is undefined, and hence strongly discouraged.
*
*
Implementations of this interface *must* be immutable and have well-defined value-based
* equals/hashCode implementations. If an implementation does not strictly conform to these
* requirements, behavior of the OpenTelemetry APIs and default SDK cannot be guaranteed.
*
*
For this reason, it is strongly suggested that you use the implementation that is provided
* here via the factory methods and the {@link AttributesBuilder}.
*/
@SuppressWarnings("rawtypes")
@Immutable
public interface Attributes {
/** Returns the value for the given {@link AttributeKey}, or {@code null} if not found. */
@Nullable
T get(AttributeKey key);
/** Iterates over all the key-value pairs of attributes contained by this instance. */
void forEach(BiConsumer, ? super Object> consumer);
/** The number of attributes contained in this. */
int size();
/** Whether there are any attributes contained in this. */
boolean isEmpty();
/** Returns a read-only view of this {@link Attributes} as a {@link Map}. */
Map, Object> asMap();
/** Returns a {@link Attributes} instance with no attributes. */
static Attributes empty() {
return ArrayBackedAttributes.EMPTY;
}
/** Returns a {@link Attributes} instance with a single key-value pair. */
static Attributes of(AttributeKey key, T value) {
if (key == null || key.getKey().isEmpty() || value == null) {
return empty();
}
return new ArrayBackedAttributes(new Object[] {key, value});
}
/**
* Returns a {@link Attributes} instance with two key-value pairs. Order of the keys is not
* preserved. Duplicate keys will be removed.
*/
static Attributes of(AttributeKey key1, T value1, AttributeKey key2, U value2) {
if (key1 == null || key1.getKey().isEmpty() || value1 == null) {
return of(key2, value2);
}
if (key2 == null || key2.getKey().isEmpty() || value2 == null) {
return of(key1, value1);
}
if (key1.getKey().equals(key2.getKey())) {
// last one in wins
return of(key2, value2);
}
if (key1.getKey().compareTo(key2.getKey()) > 0) {
return new ArrayBackedAttributes(new Object[] {key2, value2, key1, value1});
}
return new ArrayBackedAttributes(new Object[] {key1, value1, key2, value2});
}
/**
* Returns a {@link Attributes} instance with three key-value pairs. Order of the keys is not
* preserved. Duplicate keys will be removed.
*/
static Attributes of(
AttributeKey key1,
T value1,
AttributeKey key2,
U value2,
AttributeKey key3,
V value3) {
return sortAndFilterToAttributes(key1, value1, key2, value2, key3, value3);
}
/**
* Returns a {@link Attributes} instance with four key-value pairs. Order of the keys is not
* preserved. Duplicate keys will be removed.
*/
static Attributes of(
AttributeKey key1,
T value1,
AttributeKey key2,
U value2,
AttributeKey key3,
V value3,
AttributeKey key4,
W value4) {
return sortAndFilterToAttributes(key1, value1, key2, value2, key3, value3, key4, value4);
}
/**
* Returns a {@link Attributes} instance with five key-value pairs. Order of the keys is not
* preserved. Duplicate keys will be removed.
*/
@SuppressWarnings("TooManyParameters")
static Attributes of(
AttributeKey key1,
T value1,
AttributeKey key2,
U value2,
AttributeKey key3,
V value3,
AttributeKey key4,
W value4,
AttributeKey key5,
X value5) {
return sortAndFilterToAttributes(
key1, value1,
key2, value2,
key3, value3,
key4, value4,
key5, value5);
}
/**
* Returns a {@link Attributes} instance with the given key-value pairs. Order of the keys is not
* preserved. Duplicate keys will be removed.
*/
@SuppressWarnings("TooManyParameters")
static Attributes of(
AttributeKey key1,
T value1,
AttributeKey key2,
U value2,
AttributeKey key3,
V value3,
AttributeKey key4,
W value4,
AttributeKey key5,
X value5,
AttributeKey key6,
Y value6) {
return sortAndFilterToAttributes(
key1, value1,
key2, value2,
key3, value3,
key4, value4,
key5, value5,
key6, value6);
}
/** Returns a new {@link AttributesBuilder} instance for creating arbitrary {@link Attributes}. */
static AttributesBuilder builder() {
return new ArrayBackedAttributesBuilder();
}
/**
* Returns a new {@link AttributesBuilder} instance populated with the data of this {@link
* Attributes}.
*/
AttributesBuilder toBuilder();
}