com.datastax.oss.dsbulk.codecs.api

Class ConvertingCodec<EXTERNAL,INTERNAL>

java.lang.Object

com.datastax.oss.dsbulk.codecs.api.ConvertingCodec<EXTERNAL,INTERNAL>

Type Parameters:

EXTERNAL - The external type (as produced and consumed by the connector)

INTERNAL - The internal type (the one that matches the target CQL type)

All Implemented Interfaces:

TypeCodec<EXTERNAL>

Direct Known Subclasses:

BooleanToNumberCodec, BooleanToStringCodec, CollectionToCollectionCodec, DateToTemporalCodec, DateToUUIDCodec, IdempotentConvertingCodec, JsonNodeConvertingCodec, ListToTupleCodec, ListToUDTCodec, MapToMapCodec, MapToUDTCodec, NumberToBooleanCodec, NumberToInstantCodec, NumberToNumberCodec, NumberToStringCodec, NumberToUUIDCodec, StringConvertingCodec, TemporalToTemporalCodec, TemporalToUUIDCodec, WriteTimeCodec

public abstract class ConvertingCodec<EXTERNAL,INTERNAL>
extends Object
implements TypeCodec<EXTERNAL>

A codec that converts to and from an external representation of a value (i.e., the value, as produced by a connector) and its internal representation (i.e., the Java type that matches the target CQL type).

Field Summary

Fields

Modifier and Type	Field and Description
protected TypeCodec<INTERNAL>	internalCodec
protected GenericType<EXTERNAL>	javaType

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConvertingCodec(TypeCodec<INTERNAL> internalCodec, Class<EXTERNAL> javaType)
protected	ConvertingCodec(TypeCodec<INTERNAL> internalCodec, GenericType<EXTERNAL> javaType)

Method Summary

Modifier and Type	Method and Description
EXTERNAL	decode(ByteBuffer bytes, ProtocolVersion protocolVersion)
ByteBuffer	encode(EXTERNAL external, ProtocolVersion protocolVersion)
abstract INTERNAL	externalToInternal(EXTERNAL external) Converts the external representation of a value (i.e., the value, as produced by a connector) to its internal representation (i.e., the Java type that matches the target CQL type).
String	format(EXTERNAL s)
DataType	getCqlType()
TypeCodec<INTERNAL>	getInternalCodec()
GenericType<INTERNAL>	getInternalJavaType()
GenericType<EXTERNAL>	getJavaType()
abstract EXTERNAL	internalToExternal(INTERNAL internal) Converts the internal representation of a value (i.e., the Java type that matches the target CQL type) to its external representation (i.e., the value, as consumed by a connector).
EXTERNAL	parse(String s)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

accepts, accepts, accepts, accepts

Field Detail

internalCodec

protected final TypeCodec<INTERNAL> internalCodec

javaType

protected final GenericType<EXTERNAL> javaType

Constructor Detail

ConvertingCodec

protected ConvertingCodec(TypeCodec<INTERNAL> internalCodec,
                          Class<EXTERNAL> javaType)

ConvertingCodec

protected ConvertingCodec(TypeCodec<INTERNAL> internalCodec,
                          GenericType<EXTERNAL> javaType)

Method Detail

getCqlType

@NonNull
public DataType getCqlType()

Specified by:

getCqlType in interface TypeCodec<EXTERNAL>

getJavaType

@NonNull
public GenericType<EXTERNAL> getJavaType()

Specified by:

getJavaType in interface TypeCodec<EXTERNAL>

getInternalCodec

public TypeCodec<INTERNAL> getInternalCodec()

getInternalJavaType

public GenericType<INTERNAL> getInternalJavaType()

encode

public ByteBuffer encode(EXTERNAL external,
                         @NonNull
                         ProtocolVersion protocolVersion)

Specified by:

encode in interface TypeCodec<EXTERNAL>

decode

public EXTERNAL decode(ByteBuffer bytes,
                       @NonNull
                       ProtocolVersion protocolVersion)

Specified by:

decode in interface TypeCodec<EXTERNAL>

parse

public EXTERNAL parse(String s)

Specified by:

parse in interface TypeCodec<EXTERNAL>

format

@NonNull
public String format(EXTERNAL s)

Specified by:

format in interface TypeCodec<EXTERNAL>

externalToInternal

public abstract INTERNAL externalToInternal(EXTERNAL external)

Converts the external representation of a value (i.e., the value, as produced by a connector) to its internal representation (i.e., the Java type that matches the target CQL type).

Parameters:

external - the value's external form.

Returns:

the value's internal form.

internalToExternal

public abstract EXTERNAL internalToExternal(INTERNAL internal)

Converts the internal representation of a value (i.e., the Java type that matches the target CQL type) to its external representation (i.e., the value, as consumed by a connector).

Parameters:

internal - the value's internal form.

Returns:

the value's external form.