feat: Adds support for Interval datatype in Java client (#3416)

* Add support for Interval in Java Client

* Added integration test for typed query parameter and fixed Interval parsing regex

* resolved cl comments

* Improved test coverage of Interval class

* API changes for Interval Class

* Fix the values for duration constants

* Fix the values for duration constants

* fix formatting

* Run interval integration tests only against cloud-devel.

* Fixed casing of local variables

* addressed open comments

* removed dependency on jetbrains annotations

---------

Co-authored-by: Sagar Agarwal <[email protected]>

Author: sagarwaal

google-cloud-spanner/clirr-ignored-differences.xml

@@ -566,6 +566,58 @@
     <method>java.util.List getFloat32Array()</method>
   </difference>
 
+  <!-- INTERVAL -->
+  <difference>
+    <differenceType>7012</differenceType>
+    <className>com/google/cloud/spanner/StructReader</className>
+    <method>com.google.cloud.spanner.Interval getInterval(int)</method>
+  </difference>
+  <difference>
+    <differenceType>7012</differenceType>
+    <className>com/google/cloud/spanner/StructReader</className>
+    <method>com.google.cloud.spanner.Interval getInterval(java.lang.String)</method>
+  </difference>
+  <difference>
+    <differenceType>7012</differenceType>
+    <className>com/google/cloud/spanner/StructReader</className>
+    <method>com.google.cloud.spanner.Interval[] getIntervalArray(int)</method>
+  </difference>
+  <difference>
+    <differenceType>7012</differenceType>
+    <className>com/google/cloud/spanner/StructReader</className>
+    <method>com.google.cloud.spanner.Interval[] getIntervalArray(java.lang.String)</method>
+  </difference>
+  <difference>
+    <differenceType>7012</differenceType>
+    <className>com/google/cloud/spanner/StructReader</className>
+    <method>java.util.List getIntervalList(int)</method>
+  </difference>
+  <difference>
+    <differenceType>7012</differenceType>
+    <className>com/google/cloud/spanner/StructReader</className>
+    <method>java.util.List getIntervalList(java.lang.String)</method>
+  </difference>
+  <difference>
+    <differenceType>7013</differenceType>
+    <className>com/google/cloud/spanner/AbstractStructReader</className>
+    <method>com.google.cloud.spanner.Interval getIntervalInternal(int)</method>
+  </difference>
+  <difference>
+    <differenceType>7013</differenceType>
+    <className>com/google/cloud/spanner/AbstractStructReader</className>
+    <method>java.util.List getIntervalListInternal(int)</method>
+  </difference>
+  <difference>
+    <differenceType>7013</differenceType>
+    <className>com/google/cloud/spanner/Value</className>
+    <method>com.google.cloud.spanner.Interval getInterval()</method>
+  </difference>
+  <difference>
+    <differenceType>7013</differenceType>
+    <className>com/google/cloud/spanner/Value</className>
+    <method>java.util.List getIntervalArray()</method>
+  </difference>
+
   <!-- (Internal change, use stream timeout) -->
   <difference>
     <differenceType>7012</differenceType>

google-cloud-spanner/src/main/java/com/google/cloud/spanner/AbstractResultSet.java

@@ -434,6 +434,11 @@ protected Date getDateInternal(int columnIndex) {
     return currRow().getDateInternal(columnIndex);
   }
 
+  @Override
+  protected Interval getIntervalInternal(int columnIndex) {
+    return currRow().getIntervalInternal(columnIndex);
+  }
+
   @Override
   protected Value getValueInternal(int columnIndex) {
     return currRow().getValueInternal(columnIndex);
@@ -526,6 +531,11 @@ protected List<Date> getDateListInternal(int columnIndex) {
     return currRow().getDateListInternal(columnIndex);
   }
 
+  @Override
+  protected List<Interval> getIntervalListInternal(int columnIndex) {
+    return currRow().getIntervalListInternal(columnIndex);
+  }
+
   @Override
   protected List<Struct> getStructListInternal(int columnIndex) {
     return currRow().getStructListInternal(columnIndex);

google-cloud-spanner/src/main/java/com/google/cloud/spanner/AbstractStructReader.java

@@ -67,6 +67,8 @@ protected String getPgJsonbInternal(int columnIndex) {
 
   protected abstract Date getDateInternal(int columnIndex);
 
+  protected abstract Interval getIntervalInternal(int columnIndex);
+
   protected <T extends AbstractMessage> T getProtoMessageInternal(int columnIndex, T message) {
     throw new UnsupportedOperationException("Not implemented");
   }
@@ -128,6 +130,8 @@ protected List<String> getPgJsonbListInternal(int columnIndex) {
 
   protected abstract List<Date> getDateListInternal(int columnIndex);
 
+  protected abstract List<Interval> getIntervalListInternal(int columnIndex);
+
   protected abstract List<Struct> getStructListInternal(int columnIndex);
 
   @Override
@@ -299,6 +303,19 @@ public Date getDate(String columnName) {
     return getDateInternal(columnIndex);
   }
 
+  @Override
+  public Interval getInterval(int columnIndex) {
+    checkNonNullOfType(columnIndex, Type.interval(), columnIndex);
+    return getIntervalInternal(columnIndex);
+  }
+
+  @Override
+  public Interval getInterval(String columnName) {
+    int columnIndex = getColumnIndex(columnName);
+    checkNonNullOfType(columnIndex, Type.interval(), columnName);
+    return getIntervalInternal(columnIndex);
+  }
+
   @Override
   public <T extends ProtocolMessageEnum> T getProtoEnum(
       int columnIndex, Function<Integer, ProtocolMessageEnum> method) {
@@ -583,6 +600,19 @@ public List<Date> getDateList(String columnName) {
     return getDateListInternal(columnIndex);
   }
 
+  @Override
+  public List<Interval> getIntervalList(int columnIndex) {
+    checkNonNullOfType(columnIndex, Type.array(Type.interval()), columnIndex);
+    return getIntervalListInternal(columnIndex);
+  }
+
+  @Override
+  public List<Interval> getIntervalList(String columnName) {
+    int columnIndex = getColumnIndex(columnName);
+    checkNonNullOfType(columnIndex, Type.array(Type.interval()), columnName);
+    return getIntervalListInternal(columnIndex);
+  }
+
   @Override
   public List<Struct> getStructList(int columnIndex) {
     checkNonNullArrayOfStruct(columnIndex, columnIndex);

google-cloud-spanner/src/main/java/com/google/cloud/spanner/ForwardingStructReader.java

@@ -231,6 +231,18 @@ public Date getDate(String columnName) {
     return delegate.get().getDate(columnName);
   }
 
+  @Override
+  public Interval getInterval(int columnIndex) {
+    checkValidState();
+    return delegate.get().getInterval(columnIndex);
+  }
+
+  @Override
+  public Interval getInterval(String columnName) {
+    checkValidState();
+    return delegate.get().getInterval(columnName);
+  }
+
   @Override
   public boolean[] getBooleanArray(int columnIndex) {
     checkValidState();
@@ -409,6 +421,18 @@ public List<Date> getDateList(String columnName) {
     return delegate.get().getDateList(columnName);
   }
 
+  @Override
+  public List<Interval> getIntervalList(int columnIndex) {
+    checkValidState();
+    return delegate.get().getIntervalList(columnIndex);
+  }
+
+  @Override
+  public List<Interval> getIntervalList(String columnName) {
+    checkValidState();
+    return delegate.get().getIntervalList(columnName);
+  }
+
   @Override
   public <T extends AbstractMessage> List<T> getProtoMessageList(int columnIndex, T message) {
     checkValidState();

google-cloud-spanner/src/main/java/com/google/cloud/spanner/GrpcStruct.java

@@ -131,6 +131,9 @@ private Object writeReplace() {
         case DATE:
           builder.set(fieldName).to((Date) value);
           break;
+        case INTERVAL:
+          builder.set(fieldName).to((Interval) value);
+          break;
         case ARRAY:
           final Type elementType = fieldType.getArrayElementType();
           switch (elementType.getCode()) {
@@ -184,6 +187,9 @@ private Object writeReplace() {
             case DATE:
               builder.set(fieldName).toDateArray((Iterable<Date>) value);
               break;
+            case INTERVAL:
+              builder.set(fieldName).toIntervalArray((Iterable<Interval>) value);
+              break;
             case STRUCT:
               builder.set(fieldName).toStructArray(elementType, (Iterable<Struct>) value);
               break;
@@ -298,6 +304,9 @@ private static Object decodeValue(Type fieldType, com.google.protobuf.Value prot
       case DATE:
         checkType(fieldType, proto, KindCase.STRING_VALUE);
         return Date.parseDate(proto.getStringValue());
+      case INTERVAL:
+        checkType(fieldType, proto, KindCase.STRING_VALUE);
+        return Interval.parseFromString(proto.getStringValue());
       case ARRAY:
         checkType(fieldType, proto, KindCase.LIST_VALUE);
         ListValue listValue = proto.getListValue();
@@ -347,6 +356,7 @@ static Object decodeArrayValue(Type elementType, ListValue listValue) {
       case BYTES:
       case TIMESTAMP:
       case DATE:
+      case INTERVAL:
       case STRUCT:
       case PROTO:
         return Lists.transform(listValue.getValuesList(), input -> decodeValue(elementType, input));
@@ -503,6 +513,12 @@ protected Date getDateInternal(int columnIndex) {
     return (Date) rowData.get(columnIndex);
   }
 
+  @Override
+  protected Interval getIntervalInternal(int columnIndex) {
+    ensureDecoded(columnIndex);
+    return (Interval) rowData.get(columnIndex);
+  }
+
   private boolean isUnrecognizedType(int columnIndex) {
     return type.getStructFields().get(columnIndex).getType().getCode() == Code.UNRECOGNIZED;
   }
@@ -624,6 +640,8 @@ protected Value getValueInternal(int columnIndex) {
         return Value.timestamp(isNull ? null : getTimestampInternal(columnIndex));
       case DATE:
         return Value.date(isNull ? null : getDateInternal(columnIndex));
+      case INTERVAL:
+        return Value.interval(isNull ? null : getIntervalInternal(columnIndex));
       case STRUCT:
         return Value.struct(isNull ? null : getStructInternal(columnIndex));
       case UNRECOGNIZED:
@@ -664,6 +682,8 @@ protected Value getValueInternal(int columnIndex) {
             return Value.timestampArray(isNull ? null : getTimestampListInternal(columnIndex));
           case DATE:
             return Value.dateArray(isNull ? null : getDateListInternal(columnIndex));
+          case INTERVAL:
+            return Value.intervalArray(isNull ? null : getIntervalListInternal(columnIndex));
           case STRUCT:
             return Value.structArray(
                 elementType, isNull ? null : getStructListInternal(columnIndex));
@@ -847,6 +867,13 @@ protected List<Date> getDateListInternal(int columnIndex) {
     return Collections.unmodifiableList((List<Date>) rowData.get(columnIndex));
   }
 
+  @Override
+  @SuppressWarnings("unchecked") // We know ARRAY<Interval> produces a List<Interval>.
+  protected List<Interval> getIntervalListInternal(int columnIndex) {
+    ensureDecoded(columnIndex);
+    return Collections.unmodifiableList((List<Interval>) rowData.get(columnIndex));
+  }
+
   @Override
   @SuppressWarnings("unchecked") // We know ARRAY<STRUCT<...>> produces a List<STRUCT>.
   protected List<Struct> getStructListInternal(int columnIndex) {