com.datastax.driver.extras.codecs.joda.InstantCodec Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cassandra-driver-extras Show documentation
Extended functionality for the Java driver.
There is a newer version: 3.11.5
Show newest version
/*
 * 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.joda;

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.ProtocolVersion;
import com.datastax.driver.core.TypeCodec;
import com.datastax.driver.core.exceptions.InvalidTypeException;
import java.nio.ByteBuffer;
import org.joda.time.Instant;
import org.joda.time.format.DateTimeFormat;
import org.joda.time.format.DateTimeFormatter;
import org.joda.time.format.DateTimeFormatterBuilder;
import org.joda.time.format.ISODateTimeFormat;

/**
 * {@link TypeCodec} that maps {@link Instant} to CQL {@code timestamp} allowing the setting and
 * retrieval of {@code timestamp} columns as {@link Instant} instances.
 *
 * Since C* timestamp columns do not preserve timezones any attached timezone
 * information will be lost.
 *
 * IMPORTANT: this codec's {@link #format(Instant) format} method formats
 * timestamps using an ISO-8601 format that includes milliseconds. This format is
 * incompatible with Cassandra versions < 2.0.9.
 *
 * @see DateTimeCodec
 * @see 'Working with
 *     timestamps' section of CQL specification
 */
public class InstantCodec extends TypeCodec {

  public static final InstantCodec instance = new InstantCodec();

  /** A {@link DateTimeFormatter} that parses (most) of the ISO formats accepted in CQL. */
  private static final DateTimeFormatter PARSER =
      new DateTimeFormatterBuilder()
          .append(ISODateTimeFormat.dateOptionalTimeParser().getParser())
          .appendOptional(
              new DateTimeFormatterBuilder().appendTimeZoneOffset("Z", true, 2, 4).toParser())
          .toFormatter()
          .withZoneUTC();

  private static final DateTimeFormatter FORMATTER =
      DateTimeFormat.forPattern("yyyy-MM-dd'T'HH:mm:ss.SSSZZ").withZoneUTC();

  private InstantCodec() {
    super(DataType.timestamp(), Instant.class);
  }

  @Override
  public ByteBuffer serialize(Instant value, ProtocolVersion protocolVersion) {
    return value == null ? null : bigint().serializeNoBoxing(value.getMillis(), protocolVersion);
  }

  @Override
  public Instant deserialize(ByteBuffer bytes, ProtocolVersion protocolVersion) {
    if (bytes == null || bytes.remaining() == 0) return null;
    long millis = bigint().deserializeNoBoxing(bytes, protocolVersion);
    return new Instant(millis);
  }

  @Override
  public String format(Instant value) {
    if (value == null) return "NULL";
    return quote(FORMATTER.print(value));
  }

  @Override
  public 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 new Instant(parseLong(value));
      } catch (NumberFormatException e) {
        throw new InvalidTypeException(
            String.format("Cannot parse timestamp value from \"%s\"", value));
      }
    }
    try {
      return new Instant(PARSER.parseMillis(value));
    } catch (RuntimeException e) {
      throw new InvalidTypeException(
          String.format("Cannot parse timestamp value from \"%s\"", value));
    }
  }
}