com.datastax.oss.driver.api.core.type.codec

Interface PrimitiveByteCodec

All Superinterfaces:

TypeCodec<Byte>

public interface PrimitiveByteCodec
extends TypeCodec<Byte>

A specialized byte codec that knows how to deal with primitive types.

If the codec registry returns an instance of this type, the driver's byte getters will use it to avoid boxing.

Method Summary

Modifier and Type	Method and Description
default Byte	decode(ByteBuffer bytes, ProtocolVersion protocolVersion) Decodes a value from the binary format of the CQL type handled by this codec.
byte	decodePrimitive(ByteBuffer value, ProtocolVersion protocolVersion)
default ByteBuffer	encode(Byte value, ProtocolVersion protocolVersion) Encodes the given value in the binary format of the CQL type handled by this codec.
ByteBuffer	encodePrimitive(byte value, ProtocolVersion protocolVersion)

Methods inherited from interface com.datastax.oss.driver.api.core.type.codec.TypeCodec

accepts, accepts, accepts, accepts, format, getCqlType, getJavaType, parse

Method Detail

encodePrimitive

@Nullable
ByteBuffer encodePrimitive(byte value,
                                     @NonNull
                                     ProtocolVersion protocolVersion)

decodePrimitive

byte decodePrimitive(@Nullable
                     ByteBuffer value,
                     @NonNull
                     ProtocolVersion protocolVersion)

encode

@Nullable
default ByteBuffer encode(@Nullable
                                    Byte value,
                                    @NonNull
                                    ProtocolVersion protocolVersion)

Description copied from interface: TypeCodec

Encodes the given value in the binary format of the CQL type handled by this codec.

• Null values should be gracefully handled and no exception should be raised; they should be considered as the equivalent of a NULL CQL value;
• Codecs for CQL collection types should not permit null elements;
• Codecs for CQL collection types should treat a null input as the equivalent of an empty collection.

Specified by:

encode in interface TypeCodec<Byte>

decode

@Nullable
default Byte decode(@Nullable
                              ByteBuffer bytes,
                              @NonNull
                              ProtocolVersion protocolVersion)

Description copied from interface: TypeCodec

Decodes a value from the binary format of the CQL type handled by this codec.

• Null or empty buffers should be gracefully handled and no exception should be raised; they should be considered as the equivalent of a NULL CQL value and, in most cases, should map to null or a default value for the corresponding Java type, if applicable;
• Codecs for CQL collection types should clearly document whether they return immutable collections or not (note that the driver's default collection codecs return mutable collections);
• Codecs for CQL collection types should avoid returning null; they should return empty collections instead (the driver's default collection codecs all comply with this rule);
• The provided ByteBuffer should never be consumed by read operations that modify its current position; if necessary, ByteBuffer.duplicate() duplicate} it before consuming.

Specified by:

decode in interface TypeCodec<Byte>