public class Jsr353JsonCodec extends TypeCodec<javax.json.JsonStructure>
More specifically, this codec maps an arbitrary JsonStructure to a CQL varchar
column.
This codec handles the Java type JsonStructure. It is therefore required that values
are set and retrieved using that exact Java type; users should manually downcast to either JsonObject or JsonArray, as in the example below:
// setting values
JsonObject myObject = ...
PreparedStatement ps = ...
// set values using JsonStructure as target Java type
BoundStatement bs = ps.bind().set(1, myObject, JsonStructure.class);
// retrieving values
Row row = session.execute(bs).one();
// use JsonStructure as target Java type to retrieve values
JsonStructure json = row.get(0, JsonStructure.class);
if (json instanceof JsonObject) {
myObject = (JsonObject) json;
...
}
<dependency>
<groupId>javax.json</groupId>
<artifactId>javax.json-api</artifactId>
<version>1.0</version>
</dependency>
<dependency>
<groupId>org.glassfish</groupId>
<artifactId>javax.json</artifactId>
<version>1.0.4</version>
</dependency>
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| Constructor and Description |
|---|
Jsr353JsonCodec()
Creates a new instance using a default configuration.
|
Jsr353JsonCodec(Map<String,?> config)
Creates a new instance using the provided configuration.
|
| Modifier and Type | Method and Description |
|---|---|
javax.json.JsonStructure |
deserialize(ByteBuffer bytes,
ProtocolVersion protocolVersion)
Deserialize the given
ByteBuffer instance according to the CQL type handled by this
codec. |
String |
format(javax.json.JsonStructure value)
Format the given value as a valid CQL literal according to the CQL type handled by this codec.
|
javax.json.JsonStructure |
parse(String value)
Parse the given CQL literal into an instance of the Java type handled by this codec.
|
ByteBuffer |
serialize(javax.json.JsonStructure value,
ProtocolVersion protocolVersion)
Serialize the given value according to the CQL type handled by this codec.
|
accepts, 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, varintpublic Jsr353JsonCodec()
public ByteBuffer serialize(javax.json.JsonStructure value, ProtocolVersion protocolVersion) throws InvalidTypeException
TypeCodecImplementation notes:
null input as the equivalent of an
empty collection.
serialize in class TypeCodec<javax.json.JsonStructure>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 TInvalidTypeException - if the given value does not have the expected typepublic javax.json.JsonStructure deserialize(ByteBuffer bytes, ProtocolVersion protocolVersion) throws InvalidTypeException
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<javax.json.JsonStructure>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).InvalidTypeException - if the given ByteBuffer instance cannot be deserializedpublic String format(javax.json.JsonStructure value) throws InvalidTypeException
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<javax.json.JsonStructure>value - An instance of T; may be null.InvalidTypeException - if the given value does not have the expected typepublic javax.json.JsonStructure parse(String value) throws InvalidTypeException
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<javax.json.JsonStructure>value - The CQL string to parse, may be null or empty.null on a null input.InvalidTypeException - if the given value cannot be parsed into the expected typeCopyright © 2012–2023. All rights reserved.