Support OBJECT types

Author: Michael-A-McMahon

src/main/java/oracle/r2dbc/OracleR2dbcObject.java

@@ -0,0 +1,6 @@
+package oracle.r2dbc;
+
+public interface OracleR2dbcObject extends io.r2dbc.spi.Readable {
+
+  OracleR2dbcObjectMetadata getMetadata();
+}

src/main/java/oracle/r2dbc/OracleR2dbcObjectMetadata.java

@@ -0,0 +1,38 @@
+package oracle.r2dbc;
+
+import io.r2dbc.spi.ReadableMetadata;
+
+import java.util.List;
+import java.util.NoSuchElementException;
+
+public interface OracleR2dbcObjectMetadata {
+
+  /**
+   * Returns the {@link ReadableMetadata} for one attribute.
+   *
+   * @param index the attribute index starting at 0
+   * @return the {@link ReadableMetadata} for one attribute. Not null.
+   * @throws IndexOutOfBoundsException if {@code index} is out of range
+   * (negative or equals/exceeds {@code getParameterMetadatas().size()})
+   */
+  ReadableMetadata getAttributeMetadata(int index);
+
+  /**
+   * Returns the {@link ReadableMetadata} for one attribute.
+   *
+   * @param name the name of the attribute. Not null. Parameter names are
+   * case-insensitive.
+   * @return the {@link ReadableMetadata} for one attribute. Not null.
+   * @throws IllegalArgumentException if {@code name} is {@code null}
+   * @throws NoSuchElementException if there is no attribute with the
+   * {@code name}
+   */
+  ReadableMetadata getAttributeMetadata(String name);
+
+  /**
+   * Returns the {@link ReadableMetadata} for all attributes.
+   *
+   * @return the {@link ReadableMetadata} for all attributes. Not null.
+   */
+  List<? extends ReadableMetadata> getAttributeMetadatas();
+}

src/main/java/oracle/r2dbc/OracleR2dbcTypes.java

@@ -103,6 +103,12 @@ private OracleR2dbcTypes() {}
   public static final Type REF_CURSOR =
     new TypeImpl(Result.class, "SYS_REFCURSOR");
 
+  /**
+   * A user defined OBJECT type.
+   */
+  public static final Type OBJECT =
+    new TypeImpl(OracleR2dbcObject.class, "OBJECT");
+
   /**
    * <p>
    * Creates an {@link ArrayType} representing a user defined {@code ARRAY}
@@ -137,6 +143,10 @@ public static ArrayType arrayType(String name) {
     return new ArrayTypeImpl(Objects.requireNonNull(name, "name is null"));
   }
 
+  public static ObjectType objectType(String name) {
+    return new ObjectTypeImpl(Objects.requireNonNull(name, "name is null"));
+  }
+
   /**
    * Extension of the standard {@link Type} interface used to represent user
    * defined ARRAY types. An instance of {@code ArrayType} must be used when
@@ -179,6 +189,31 @@ public interface ArrayType extends Type {
     String getName();
   }
 
+  public interface ObjectType extends Type {
+
+    /**
+     * {@inheritDoc}
+     * Returns {@code Object[].class}, which is the standard mapping for
+     * {@link R2dbcType#COLLECTION}. The true default type mapping is the array
+     * variant of the default mapping for the element type of the {@code ARRAY}.
+     * For instance, an {@code ARRAY} of {@code VARCHAR} maps to a
+     * {@code String[]} by default.
+     */
+    @Override
+    Class<?> getJavaType();
+
+    /**
+     * {@inheritDoc}
+     * Returns the name of this user defined {@code ARRAY} type. For instance,
+     * this method returns "MY_ARRAY" if the type is declared as:
+     * <pre>{@code
+     * CREATE TYPE MY_ARRAY AS ARRAY(8) OF NUMBER
+     * }</pre>
+     */
+    @Override
+    String getName();
+  }
+
   /** Concrete implementation of the {@code ArrayType} interface */
   private static final class ArrayTypeImpl
     extends TypeImpl implements ArrayType {
@@ -195,6 +230,23 @@ private static final class ArrayTypeImpl
     }
   }
 
+  /** Concrete implementation of the {@code ObjectType} interface */
+  private static final class ObjectTypeImpl
+    extends TypeImpl implements ObjectType {
+
+    /**
+     * Constructs an ARRAY type with the given {@code name}. The constructed
+     * {@code ObjectType} as a default Java type mapping of
+     * {@code Object[].class}. This is consistent with the standard
+     * {@link R2dbcType#COLLECTION} type.
+     * @param name User defined name of the type. Not null.
+     */
+    ObjectTypeImpl(String name) {
+      // TODO: Consider defining Readable.class as the default type mapping.
+      super(Object.class, name);
+    }
+  }
+
   /**
    * Implementation of the {@link Type} SPI.
    */