Top Description Fields Constructors Methods
io.opentelemetry.api.internal

public abstract Class ImmutableKeyValuePairs<K, V>

extends Object
Class Inheritance
Known Direct Subclasses
io.opentelemetry.api.baggage.ImmutableBaggage, io.opentelemetry.api.common.ArrayBackedAttributes
Annotations
@Immutable
Type Parameters
<V>
The type of the values contained in this.
Static Imports
io.opentelemetry.api.internal.Utils.checkArgument
An immutable set of key-value pairs.

Key-value pairs are dropped for null or empty keys.

Note

for subclasses of this, null keys will be removed, but if your key has another concept of being "empty", you'll need to remove them before calling the constructor, assuming you don't want the "empty" keys to be kept in your collection.

This class is internal and is hence not for public use. Its APIs are unstable and can change at any time.

Field Summary

Modifier and TypeField and Description
private final Object[]
data

private int
hashcode

Constructor Summary

AccessConstructor and Description
protected
ImmutableKeyValuePairs(Object[] data)

Stores the raw object data directly.

protected
ImmutableKeyValuePairs(Object[] data, Comparator<?> keyComparator)

Sorts and dedupes the key/value pairs in data.

Method Summary

Modifier and TypeMethod and Description
public final Map<K, V>
asMap()

private static <K> int
compareToNullSafe(K key, K pivotKey, Comparator<K> keyComparator)

protected final List<Object>
data()

private static <K> Object[]
dedupe(Object[] data, Comparator<K> keyComparator)

public boolean
equals(Object
the reference object with which to compare.
o)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public final void
forEach(BiConsumer<? super K, ? super V> consumer)

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

public final V
get(K key)

Returns the value for the given key, or null if the key is not present.

public Object[]
getData()

Return the backing data array for these attributes.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public final boolean
isEmpty()

private static <K> void
merge(Object[] sourceArray, int beginIndex, int middleIndex, int endIndex, Object[] targetArray, Comparator<K> keyComparator)

Left source half is sourceArray[ beginIndex:middleIndex-1].

private static void
mergeSort(Object[] data, Comparator<?> keyComparator)

public final int
size()

private static Object[]
sortAndFilter(Object[] data, Comparator<?> keyComparator)

Sorts and dedupes the key/value pairs in data.

private static void
splitAndMerge(Object[] workArray, int beginIndex, int endIndex, Object[] targetArray, Comparator<?> keyComparator)

Sort the given run of array targetArray[] using array workArray[] as a source.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

databack to summary
private final Object[] data
hashcodeback to summary
private int hashcode

Constructor Detail

ImmutableKeyValuePairsback to summary
protected ImmutableKeyValuePairs(Object[] data)

Stores the raw object data directly. Does not do any de-duping or sorting. If you use this constructor, you *must* guarantee that the data has been de-duped and sorted by key before it is passed here.

ImmutableKeyValuePairsback to summary
protected ImmutableKeyValuePairs(Object[] data, Comparator<?> keyComparator)

Sorts and dedupes the key/value pairs in data. null values will be removed. Keys will be compared with the given Comparator.

Method Detail

asMapback to summary
public final Map<K, V> asMap()
compareToNullSafeback to summary
private static <K> int compareToNullSafe(K key, K pivotKey, Comparator<K> keyComparator)
databack to summary
protected final List<Object> data()
dedupeback to summary
private static <K> Object[] dedupe(Object[] data, Comparator<K> keyComparator)
Annotations
@SuppressWarnings:unchecked
equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
forEachback to summary
public final void forEach(BiConsumer<? super K, ? super V> consumer)

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

Annotations
@SuppressWarnings:unchecked
getback to summary
public final V get(K key)

Returns the value for the given key, or null if the key is not present.

Annotations
@Nullable
@SuppressWarnings:unchecked
getDataback to summary
public Object[] getData()

Return the backing data array for these attributes. This is only exposed for internal use by opentelemetry authors. The contents of the array MUST NOT be modified.

Annotations
@SuppressWarnings:AvoidObjectArrays
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
isEmptyback to summary
public final boolean isEmpty()
mergeback to summary
private static <K> void merge(Object[] sourceArray, int beginIndex, int middleIndex, int endIndex, Object[] targetArray, Comparator<K> keyComparator)

Left source half is sourceArray[ beginIndex:middleIndex-1]. Right source half is sourceArray[ middleIndex:endIndex-1]. Result is targetArray[ beginIndex:endIndex-1].

Annotations
@SuppressWarnings:unchecked
mergeSortback to summary
private static void mergeSort(Object[] data, Comparator<?> keyComparator)
sizeback to summary
public final int size()
sortAndFilterback to summary
private static Object[] sortAndFilter(Object[] data, Comparator<?> keyComparator)

Sorts and dedupes the key/value pairs in data. null values will be removed. Keys will be compared with the given Comparator.

splitAndMergeback to summary
private static void splitAndMerge(Object[] workArray, int beginIndex, int endIndex, Object[] targetArray, Comparator<?> keyComparator)

Sort the given run of array targetArray[] using array workArray[] as a source. beginIndex is inclusive; endIndex is exclusive (targetArray[endIndex] is not in the set).

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override