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

public final Class InternalAttributeKeyImpl<T>

extends Object
implements AttributeKey<T>
Class Inheritance
All Implemented Interfaces
io.opentelemetry.api.common.AttributeKey
Imports
io.opentelemetry.api.common.AttributeKey, .AttributeType, java.nio.charset.StandardCharsets, javax.annotation.Nullable
Default AttributeKey implementation which preencodes to UTF8 for OTLP export.

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 int
hashCode

private final String
key

private byte[]
keyUtf8

private final AttributeType
type

Constructor Summary

AccessConstructor and Description
private
InternalAttributeKeyImpl(AttributeType type, String key)

Method Summary

Modifier and TypeMethod and Description
private int
buildHashCode()

private static int
buildHashCode(AttributeType type, String key)

public static <T> AttributeKey<T>
create(String key, AttributeType type)

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 String
getKey()

Implements io.opentelemetry.api.common.AttributeKey.getKey.

Returns the underlying String representation of the key.

public byte[]
getKeyUtf8()

Returns the key, encoded as UTF-8 bytes.

public AttributeType
getType()

Implements io.opentelemetry.api.common.AttributeKey.getType.

Returns the type of attribute for this key.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

hashCodeback to summary
private final int hashCode
keyback to summary
private final String key
keyUtf8back to summary
private byte[] keyUtf8
Annotations
@Nullable
typeback to summary
private final AttributeType type

Constructor Detail

InternalAttributeKeyImplback to summary
private InternalAttributeKeyImpl(AttributeType type, String key)

Method Detail

buildHashCodeback to summary
private int buildHashCode()
Annotations
@SuppressWarnings:unused
buildHashCodeback to summary
private static int buildHashCode(AttributeType type, String key)
createback to summary
public static <T> AttributeKey<T> create(String key, AttributeType type)
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
getKeyback to summary
public String getKey()

Implements io.opentelemetry.api.common.AttributeKey.getKey.

Doc from io.opentelemetry.api.common.AttributeKey.getKey.

Returns the underlying String representation of the key.

Annotations
@Override
getKeyUtf8back to summary
public byte[] getKeyUtf8()

Returns the key, encoded as UTF-8 bytes.

getTypeback to summary
public AttributeType getType()

Implements io.opentelemetry.api.common.AttributeKey.getType.

Doc from io.opentelemetry.api.common.AttributeKey.getType.

Returns the type of attribute for this key. Useful for building switch statements.

Annotations
@Override
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
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