Package io.opentelemetry.api.common

Interface Value<T>

Type Parameters:

T - the type. See getValue() for description of types.

public interface Value<T>

Value mirrors the proto AnyValue message type, and is used to model any type.

It can be used to represent:

• Primitive values via of(long), of(String), of(boolean), of(double).
• String-keyed maps (i.e. associative arrays, dictionaries) via of(KeyValue...), of(Map). Note, because map values are type Value, maps can be nested within other maps.
• Arrays (heterogeneous or homogenous) via of(Value[]). Note, because array values are type Value, arrays can contain primitives, complex types like maps or arrays, or any combination.
• Raw bytes via of(byte[])

Currently, Value is only used as an argument for LogRecordBuilder.setBody(Value).

Since:

1.42.0

Method Summary

Modifier and Type	Method	Description
String	asString()	Return a string encoding of this Value.
ValueType	getType()	Returns the type of this Value.
T	getValue()	Returns the value for this Value.
static Value<Boolean>	of(boolean value)	Returns an Value for the boolean value.
static Value<ByteBuffer>	of(byte[] value)	Returns an Value for the byte[] value.
static Value<Double>	of(double value)	Returns an Value for the double value.
static Value<Long>	of(long value)	Returns an Value for the long value.
static Value<List<KeyValue>>	of(KeyValue... value)	Returns an Value for the array of KeyValue values.
static Value<List<Value<?>>>	of(Value<?>... value)	Returns an Value for the array of Value values.
static Value<String>	of(String value)	Returns an Value for the String value.
static Value<List<Value<?>>>	of(List<Value<?>> value)	Returns an Value for the list of Value values.
static Value<List<KeyValue>>	of(Map<String,Value<?>> value)	Returns an Value for the Map of key, Value.

Method Details

of

static Value<String> of(String value)

Returns an Value for the String value.

of

static Value<Boolean> of(boolean value)

Returns an Value for the boolean value.

of

static Value<Long> of(long value)

Returns an Value for the long value.

of

static Value<Double> of(double value)

Returns an Value for the double value.

of

static Value<ByteBuffer> of(byte[] value)

Returns an Value for the byte[] value.

of

static Value<List<Value<?>>> of(Value<?>... value)

Returns an Value for the array of Value values.

of

static Value<List<Value<?>>> of(List<Value<?>> value)

Returns an Value for the list of Value values.

of

static Value<List<KeyValue>> of(KeyValue... value)

Returns an Value for the array of KeyValue values. KeyValue.getKey() values should not repeat - duplicates may be dropped.

of

static Value<List<KeyValue>> of(Map<String,Value<?>> value)

Returns an Value for the Map of key, Value.

getType

ValueType getType()

Returns the type of this Value. Useful for building switch statements.

getValue

T getValue()

Returns the value for this Value.

The return type varies by getType() as described below:

• ValueType.STRING returns String
• ValueType.BOOLEAN returns boolean
• ValueType.LONG returns long
• ValueType.DOUBLE returns double
• ValueType.ARRAY returns List of Value
• ValueType.KEY_VALUE_LIST returns List of KeyValue
• ValueType.BYTES returns read only ByteBuffer. See ByteBuffer.asReadOnlyBuffer().

asString

String asString()

Return a string encoding of this Value. This is intended to be a fallback serialized representation in case there is no suitable encoding that can utilize getType() / getValue() to serialize specific types.

WARNING: No guarantees are made about the encoding of this string response. It MAY change in a future minor release. If you need a reliable string encoding, write your own serializer.