Package org.apache.iceberg.variants

Interface VariantValue

All Known Subinterfaces:

VariantArray, VariantObject, VariantPrimitive<T>

public interface VariantValue

A variant value.

Method Summary

Modifier and Type	Method	Description
default VariantArray	asArray()	Returns this value as a VariantArray.
default VariantObject	asObject()	Returns this value as a VariantObject.
default VariantPrimitive<?>	asPrimitive()	Returns this value as a VariantPrimitive.
static VariantValue	from(VariantMetadata metadata, ByteBuffer value)
int	sizeInBytes()	Returns the serialized size in bytes of this value.
PhysicalType	type()	Returns the PhysicalType of this value.
int	writeTo(ByteBuffer buffer, int offset)	Writes this value to the buffer at the given offset, ignoring the buffer's position and limit.

Method Details

type

PhysicalType type()

Returns the PhysicalType of this value.

sizeInBytes

int sizeInBytes()

Returns the serialized size in bytes of this value.

writeTo

int writeTo(ByteBuffer buffer,
 int offset)

Writes this value to the buffer at the given offset, ignoring the buffer's position and limit.

asPrimitive

default VariantPrimitive<?> asPrimitive()

Returns this value as a VariantPrimitive.

Throws:

IllegalArgumentException - if the value is not a primitive

asObject

default VariantObject asObject()

Returns this value as a VariantObject.

Throws:

IllegalArgumentException - if the value is not an object

asArray

default VariantArray asArray()

Returns this value as a VariantArray.

Throws:

IllegalArgumentException - if the value is not an array

from

static VariantValue from(VariantMetadata metadata,
 ByteBuffer value)