public abstract static class TypeCodec.AbstractCollectionCodec<E,C extends Collection<E>> extends TypeCodec<C>
TypeCodec.AbstractCollectionCodec<E,C extends Collection<E>>, TypeCodec.AbstractMapCodec<K,V>, TypeCodec.AbstractTupleCodec<T>, TypeCodec.AbstractUDTCodec<T>, TypeCodec.PrimitiveBooleanCodec, TypeCodec.PrimitiveByteCodec, TypeCodec.PrimitiveDoubleCodec, TypeCodec.PrimitiveFloatCodec, TypeCodec.PrimitiveIntCodec, TypeCodec.PrimitiveLongCodec, TypeCodec.PrimitiveShortCodec| Modifier | Constructor and Description |
|---|---|
protected |
AbstractCollectionCodec(DataType.CollectionType cqlType,
TypeToken<C> javaType,
TypeCodec<E> eltCodec) |
| Modifier and Type | Method and Description |
|---|---|
boolean |
accepts(Object value)
Return
true if this codec is capable of serializing the given object. |
C |
deserialize(ByteBuffer bytes,
ProtocolVersion protocolVersion)
Deserialize the given
ByteBuffer instance according to the CQL type handled by this
codec. |
String |
format(C value)
Format the given value as a valid CQL literal according to the CQL type handled by this codec.
|
protected abstract C |
newInstance(int size)
Return a new instance of
C with the given estimated size. |
C |
parse(String value)
Parse the given CQL literal into an instance of the Java type handled by this codec.
|
ByteBuffer |
serialize(C value,
ProtocolVersion protocolVersion)
Serialize the given value according to the CQL type handled by this codec.
|
accepts, accepts, accepts, ascii, bigint, blob, cboolean, cdouble, cfloat, cint, counter, custom, date, decimal, duration, getCqlType, getJavaType, inet, list, map, set, smallInt, time, timestamp, timeUUID, tinyInt, toString, tuple, userType, uuid, varchar, varintprotected AbstractCollectionCodec(DataType.CollectionType cqlType, TypeToken<C> javaType, TypeCodec<E> eltCodec)
public ByteBuffer serialize(C value, ProtocolVersion protocolVersion)
TypeCodecImplementation notes:
null input as the equivalent of an
empty collection.
serialize in class TypeCodec<C extends Collection<E>>value - An instance of T; may be null.protocolVersion - the protocol version to use when serializing bytes. In most
cases, the proper value to provide for this argument is the value returned by ProtocolOptions.getProtocolVersion() (which is the protocol version in use by the driver).ByteBuffer instance containing the serialized form of Tpublic C deserialize(ByteBuffer bytes, ProtocolVersion protocolVersion)
TypeCodecByteBuffer instance according to the CQL type handled by this
codec.
Implementation notes:
null or a default value for the corresponding Java type, if
applicable;
null; they should return
empty collections instead (the driver's default collection codecs all comply with this
rule).
ByteBuffer should never be consumed by read operations that modify
its current position; if necessary, ByteBuffer.duplicate() duplicate} it before
consuming.
deserialize in class TypeCodec<C extends Collection<E>>bytes - A ByteBuffer instance containing the serialized form of T; may be null or empty.protocolVersion - the protocol version to use when serializing bytes. In most
cases, the proper value to provide for this argument is the value returned by ProtocolOptions.getProtocolVersion() (which is the protocol version in use by the driver).public String format(C value)
TypeCodecImplementors should take care of quoting and escaping the resulting CQL literal where
applicable. Null values should be accepted; in most cases, implementations should return the
CQL keyword "NULL" for null inputs.
Implementing this method is not strictly mandatory. It is used:
BuiltStatement for a detailed explanation of when
this happens);
QueryLogger, if parameter logging is enabled;
AggregateMetadata.asCQLQuery(boolean);
toString() implementation of some objects (UDTValue, TupleValue, and the internal representation of a ROWS response), which may
appear in driver logs.
format in class TypeCodec<C extends Collection<E>>value - An instance of T; may be null.public C parse(String value)
TypeCodecImplementors should take care of unquoting and unescaping the given CQL string where
applicable. Null values and empty Strings should be accepted, as well as the string "NULL"; in most cases, implementations should interpret these inputs has equivalent to a
null reference.
Implementing this method is not strictly mandatory: internally, the driver only uses it to parse the INITCOND when building the metadata of an aggregate function (and in most cases it will use a built-in codec, unless the INITCOND has a custom type).
parse in class TypeCodec<C extends Collection<E>>value - The CQL string to parse, may be null or empty.null on a null input.public boolean accepts(Object value)
TypeCodectrue if this codec is capable of serializing the given object. Note that the
object's Java type is inferred from the object's runtime (raw) type, contrary to TypeCodec.accepts(TypeToken) which is capable of handling generic types.
This method is intended mostly to be used by the QueryBuilder when no type information is available when the codec is used.
Implementation notes:
Class.isAssignableFrom(Class)) and it's strongly
recommended not to modify this behavior. This means that, by default, a codec will
accept any subtype of the Java type that it has been created for.
accepts in class TypeCodec<C extends Collection<E>>value - The Java type this codec should serialize from and deserialize to; cannot be
null.true if the codec is capable of serializing the given javaType, and
false otherwise.protected abstract C newInstance(int size)
C with the given estimated size.size - The estimated size of the collection to create.C with the given estimated size.Copyright © 2012–2024. All rights reserved.