com.datastax.driver.extras.codecs.jdk8.InstantCodec Maven / Gradle / Ivy
Show all versions of scylla-driver-extras Show documentation
/*
* Copyright DataStax, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.datastax.driver.extras.codecs.jdk8;
import static com.datastax.driver.core.ParseUtils.isLongLiteral;
import static com.datastax.driver.core.ParseUtils.isQuoted;
import static com.datastax.driver.core.ParseUtils.quote;
import static com.datastax.driver.core.ParseUtils.unquote;
import static java.lang.Long.parseLong;
import com.datastax.driver.core.DataType;
import com.datastax.driver.core.IgnoreJDK6Requirement;
import com.datastax.driver.core.ProtocolVersion;
import com.datastax.driver.core.TypeCodec;
import com.datastax.driver.core.exceptions.InvalidTypeException;
import java.nio.ByteBuffer;
/**
* {@link TypeCodec} that maps {@link java.time.Instant} to CQL {@code timestamp} allowing the
* setting and retrieval of {@code timestamp} columns as {@link java.time.Instant} instances.
*
* Since C* timestamp columns do not preserve timezones any attached timezone
* information will be lost.
*
*
IMPORTANT: this codec's {@link #format(java.time.Instant) format} method
* formats timestamps using an ISO-8601 format that includes milliseconds. This format is
* incompatible with Cassandra versions < 2.0.9.
*
* @see ZonedDateTimeCodec
* @see 'Working with
* timestamps' section of CQL specification
*/
@IgnoreJDK6Requirement
@SuppressWarnings("Since15")
public class InstantCodec extends TypeCodec {
public static final InstantCodec instance = new InstantCodec();
/**
* A {@link java.time.format.DateTimeFormatter} that parses (most) of the ISO formats accepted in
* CQL.
*/
private static final java.time.format.DateTimeFormatter PARSER =
new java.time.format.DateTimeFormatterBuilder()
.parseCaseSensitive()
.parseStrict()
.append(java.time.format.DateTimeFormatter.ISO_LOCAL_DATE)
.optionalStart()
.appendLiteral('T')
.appendValue(java.time.temporal.ChronoField.HOUR_OF_DAY, 2)
.appendLiteral(':')
.appendValue(java.time.temporal.ChronoField.MINUTE_OF_HOUR, 2)
.optionalEnd()
.optionalStart()
.appendLiteral(':')
.appendValue(java.time.temporal.ChronoField.SECOND_OF_MINUTE, 2)
.optionalEnd()
.optionalStart()
.appendFraction(java.time.temporal.ChronoField.NANO_OF_SECOND, 0, 9, true)
.optionalEnd()
.optionalStart()
.appendZoneId()
.optionalEnd()
.toFormatter()
.withZone(java.time.ZoneOffset.UTC);
private static final java.time.format.DateTimeFormatter FORMATTER =
java.time.format.DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm:ss.SSSxxx")
.withZone(java.time.ZoneOffset.UTC);
private InstantCodec() {
super(DataType.timestamp(), java.time.Instant.class);
}
@Override
public ByteBuffer serialize(java.time.Instant value, ProtocolVersion protocolVersion) {
return value == null ? null : bigint().serializeNoBoxing(value.toEpochMilli(), protocolVersion);
}
@Override
public java.time.Instant deserialize(ByteBuffer bytes, ProtocolVersion protocolVersion) {
return bytes == null || bytes.remaining() == 0
? null
: java.time.Instant.ofEpochMilli(bigint().deserializeNoBoxing(bytes, protocolVersion));
}
@Override
public String format(java.time.Instant value) {
if (value == null) return "NULL";
return quote(FORMATTER.format(value));
}
@Override
public java.time.Instant parse(String value) {
if (value == null || value.isEmpty() || value.equalsIgnoreCase("NULL")) return null;
// strip enclosing single quotes, if any
if (isQuoted(value)) value = unquote(value);
if (isLongLiteral(value)) {
try {
return java.time.Instant.ofEpochMilli(parseLong(value));
} catch (NumberFormatException e) {
throw new InvalidTypeException(
String.format("Cannot parse timestamp value from \"%s\"", value));
}
}
try {
return java.time.Instant.from(PARSER.parse(value));
} catch (java.time.format.DateTimeParseException e) {
throw new InvalidTypeException(
String.format("Cannot parse timestamp value from \"%s\"", value));
}
}
}