Package io.opentelemetry.sdk.metrics.internal.view

Class FilteredAttributes

java.lang.Object

io.opentelemetry.sdk.metrics.internal.view.FilteredAttributes

All Implemented Interfaces:

Attributes

Direct Known Subclasses:

FilteredAttributes.RegularFilteredAttributes, FilteredAttributes.SmallFilteredAttributes

abstract class FilteredAttributes
extends Object
implements Attributes

Filtered attributes is a filtered view of a ImmutableKeyValuePairs backed Attributes instance. Rather than creating an entirely new attributes instance, it keeps track of which source attributes are excluded while implementing the Attributes interface.

Notably, the equals(Object) and hashCode() depend on comparison against other FilteredAttributes instances. This means that where FilteredAttributes is used for things like map keys, it must be used for all keys in that map. You cannot mix Attributes implementations. This is also true for the default attributes implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	FilteredAttributes.RegularFilteredAttributes	Implementation that can handle attributes of arbitrary size by storing filter status in a BitSet.
private static class	FilteredAttributes.SmallFilteredAttributes	Implementation that relies on the source having less than FilteredAttributes.SmallFilteredAttributes.BITS_PER_INTEGER attributes, and storing entry filter status in the bits of an integer.

Field Summary

Fields

Modifier and Type	Field	Description
private final int	hashcode
private final int	size
private final Object[]	sourceData

Constructor Summary

Constructors

Modifier	Constructor	Description
private	FilteredAttributes(Object[] sourceData, int hashcode, int size)

Method Summary

Modifier and Type	Method	Description
Map<AttributeKey<?>,Object>	asMap()	Returns a read-only view of this Attributes as a Map.
private static Attributes	convertToStandardImplementation(Attributes source)
(package private) static Attributes	create(Attributes source, Set<AttributeKey<?>> includedKeys)	Create a FilteredAttributes instance.
boolean	equals(Object object)
void	forEach(BiConsumer<? super AttributeKey<?>,? super Object> consumer)	Iterates over all the key-value pairs of attributes contained by this instance.
<T> T	get(AttributeKey<T> key)	Returns the value for the given AttributeKey, or null if not found.
int	hashCode()
(package private) abstract boolean	includeIndexInOutput(int sourceIndex)
boolean	isEmpty()	Whether there are any attributes contained in this.
private static <T> void	putInBuilder(AttributesBuilder builder, AttributeKey<T> key, T value)
int	size()	The number of attributes contained in this.
AttributesBuilder	toBuilder()	Returns a new AttributesBuilder instance populated with the data of this Attributes.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

sourceData

private final Object[] sourceData

hashcode

private final int hashcode

size

private final int size

Constructor Details

FilteredAttributes

private FilteredAttributes(Object[] sourceData,
 int hashcode,
 int size)

Method Details

create

static Attributes create(Attributes source,
 Set<AttributeKey<?>> includedKeys)

Create a FilteredAttributes instance.

Parameters:

source - the source attributes, which SHOULD be based on the standard ImmutableKeyValuePairs. If not, the source will first be converted to the standard implementation.

includedKeys - the set of attribute keys to include in the output.

convertToStandardImplementation

private static Attributes convertToStandardImplementation(Attributes source)

get

@Nullable
public <T> T get(AttributeKey<T> key)

Description copied from interface: Attributes

Returns the value for the given AttributeKey, or null if not found.

Specified by:

get in interface Attributes

forEach

public void forEach(BiConsumer<? super AttributeKey<?>,? super Object> consumer)

Description copied from interface: Attributes

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

Specified by:

forEach in interface Attributes

size

public int size()

Description copied from interface: Attributes

The number of attributes contained in this.

Specified by:

size in interface Attributes

isEmpty

public boolean isEmpty()

Description copied from interface: Attributes

Whether there are any attributes contained in this.

Specified by:

isEmpty in interface Attributes

asMap

public Map<AttributeKey<?>,Object> asMap()

Description copied from interface: Attributes

Returns a read-only view of this Attributes as a Map.

Specified by:

asMap in interface Attributes

toBuilder

public AttributesBuilder toBuilder()

Description copied from interface: Attributes

Returns a new AttributesBuilder instance populated with the data of this Attributes.

Specified by:

toBuilder in interface Attributes

putInBuilder

private static <T> void putInBuilder(AttributesBuilder builder,
 AttributeKey<T> key,
 T value)

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

includeIndexInOutput

abstract boolean includeIndexInOutput(int sourceIndex)