Surface API Review - Review comments

Author: joviegas

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/document/EnhancedDocument.java

@@ -37,6 +37,50 @@
  *
  * TODO : Add some examples in the Java Doc after API Surface review.
  */
+
+/**
+ * The Document API interface for DynamoDB provides operations for working with unstructured data. This includes data with no
+ * fixed schema, data that can't be modeled using rigid types, or data that has a flexible schema. This interface defines
+ * methods for accessing a Document and provides constructor methods for instantiating a Document object. You can use the
+ * Document object to read and write data to DynamoDB using the EnhancedDynamoDB client.
+ * se the methods defined in this interface to perform operations such as adding, retrieving, updating, and deleting data.  For
+ * example, you can use the {@code putItem} method to add an item to a DynamoDB table, or the {@code getItem} method to
+ * retrieve  an item from a table.
+ * To use the Document API, you must first create an instance of the EnhancedDynamoDB client. Then, you can use the methods
+ * defined in this interface to interact with the data stored in DynamoDB.
+ * {@code Example Usage:}
+ * <pre>{@code
+ * EnhancedDynamoDbClient enhancedClient = EnhancedDynamoDbClient.builder()
+ *
+ * markdown
+ *
+ *        .dynamoDbClient(dynamoDbClient)
+ *
+ * markdown
+ *
+ *        .build();
+ *
+ * // Create a new Document object
+ * Document document = Document.create();
+ * // Add an item to the Document
+ * document.put("key", "value");
+ * // Write the item to DynamoDB using the EnhancedDynamoDB client
+ * enhancedClient.putItem(PutItemEnhancedRequest.builder("tableName").item(document).build());
+ * // Retrieve the item from DynamoDB
+ * GetItemEnhancedResponse<Document> response = enhancedClient.getItem(GetItemEnhancedRequest.builder("tableName")
+ *
+ * less
+ *
+ *        .key(Collections.singletonMap("partitionKey", "partitionValue"))
+ *
+ * markdown
+ *
+ *        .build());
+ *
+ * // Get the item from the response
+ * Document retrievedItem = response.item();
+ * }</pre>
+ * */
 @SdkPublicApi
 public interface EnhancedDocument {
 
@@ -234,7 +278,7 @@ static Builder builder() {
      * @return value of the specified attribute in the current document as a map of string-to-<code>T</code>'s; or null if the
      * attribute either doesn't exist or the attribute value is null.
      */
-    <T> Map<String, T> getMap(String attributeName, EnhancedType<T> type);
+    <T> Map<String, T> getMapOfType(String attributeName, EnhancedType<T> type);
 
     /**
      * Convenience method to return the specified attribute in the current item as a (copy of) map of
@@ -288,24 +332,15 @@ <T extends Number> Map<String, T> getMapOfNumbers(String attributeName,
     String getJson(String attributeName);
 
     /**
-     * Gets the JSON document value as pretty Json string for the specified attribute.
-     *
-     * @param attributeName Name of the attribute.
-     * @return value of the specified attribute in the current document as a JSON string with pretty indentation; or null if the
-     * attribute either doesn't exist or the attribute value is null.
-     */
-    String getJsonPretty(String attributeName);
-
-    /**
-     * Gets the {@link Boolean} value for the specified attribute.
+     * Gets the boolean value for the specified attribute.
      *
      * @param attributeName Name of the attribute.
      * @return value of the specified attribute in the current document as a non-null Boolean.
      * @throws RuntimeException
      *             if either the attribute doesn't exist or if the attribute
      *             value cannot be converted into a boolean value.
      */
-    Boolean getBoolean(String attributeName);
+    boolean getBoolean(String attributeName);
 
     /**
      * Gets the value as Object for a given attribute in the current document.

services-custom/dynamodb-enhanced/src/main/java/software/amazon/awssdk/enhanced/dynamodb/internal/document/DefaultEnhancedDocument.java

@@ -206,7 +206,7 @@ public List<?> getList(String attributeName) {
     }
 
     @Override
-    public <T> Map<String, T> getMap(String attributeName, EnhancedType<T> type) {
+    public <T> Map<String, T> getMapOfType(String attributeName, EnhancedType<T> type) {
         validateConverter(type);
         AttributeValue attributeValue = attributeValueMap.get(attributeName);
         if (attributeValue == null || !attributeValue.hasM()) {
@@ -275,13 +275,7 @@ public String getJson(String attributeName) {
     }
 
     @Override
-    public String getJsonPretty(String attributeName) {
-        //TODO : Implementation in next revision or next PR.
-        throw new UnsupportedOperationException("Currently unsupported");
-    }
-
-    @Override
-    public Boolean getBoolean(String attributeName) {
+    public boolean getBoolean(String attributeName) {
         return getBool(attributeName);
     }
 

services-custom/dynamodb-enhanced/src/test/java/software/amazon/awssdk/enhanced/dynamodb/document/DefaultEnhancedDocumentTest.java

@@ -402,7 +402,7 @@ void multipleGetterForDocument(){
         Map<String , BigDecimal> bigDecimalMap = new LinkedHashMap<>();
         bigDecimalMap.put("k1", BigDecimal.valueOf(3));
         bigDecimalMap.put("k2", BigDecimal.valueOf(9));
-        assertThat(document.getMap("simpleMap", EnhancedType.of(BigDecimal.class))).isEqualTo(bigDecimalMap);
+        assertThat(document.getMapOfType("simpleMap", EnhancedType.of(BigDecimal.class))).isEqualTo(bigDecimalMap);
         assertThat(document.getMapAsDocument("nestedDoc").getStringSet("innerKey")).isEqualTo(getStringSet(STRINGS_ARRAY));
         assertThat(document.getTypeOf("nullKey")).isNull();
     }

services-custom/dynamodb-enhanced/src/test/java/software/amazon/awssdk/enhanced/dynamodb/functionaltests/document/APISurfaceAreaReview.java

@@ -117,6 +117,9 @@ void createTableSchema() {
                                                        .build());
 
 
+
+
+
         /**
          * Creating SCHEMA with Primary and secondary keys
          */
@@ -189,6 +192,7 @@ void enhancedDocDefaultSimpleAttributes() {
                                                                      Stream.of(SdkBytes.fromUtf8String("a")).collect(Collectors.toSet()))
                                                      .build();
 
+
         /**
          *{
          *    "HashKey":"abcdefg123",
@@ -285,6 +289,10 @@ void generic_access_to_enhancedDcoument_attributes() {
 
         // Extracting Custom Object\
         CustomClassForDocumentAPI customAttr = customDoc.get("custom_attr", EnhancedType.of(CustomClassForDocumentAPI.class));
+
+
+        customDoc.get("custom_attr");
+
         System.out.println("customAttr " +customAttr);
         assertThat(customAttr).isEqualTo(customObject);
 
@@ -341,13 +349,14 @@ void putSimpleDocumentWithSimpleValues() {
     }
 
     /**
-     *- Does EnhancedDocument.Builder needs add(key, Object, attributeConverterProvider)
+     *- Does EnhancedDocument.Builder needs add(key, Object, attributeConverterProvider) ==> Not required , since at the time
+     * of building the User can pass AttributeCOnverters using addAttributeConveters
      *
      * - Should we refer bytes as binary or byte in apis example addBinary(byte[] byte) or addByte(byte[] byte)
      *
      * - Map<String, Object> getRawMap(String attributeName); ==> Can we remove the use of Object ? <Zoe>
      *
-     * - getJsonPretty. Do we actually need this?
+     * - getJsonPretty. Do we actually need this? ==> removed
      *
      * - Object get(String attributeName); ==> Do we need this
      * -  We don't have jsonPretty utility elsewhere. Do we need it?

services-custom/dynamodb-enhanced/src/test/java/software/amazon/awssdk/enhanced/dynamodb/mapper/DocumentTableSchemaTest.java

@@ -187,7 +187,7 @@ private static EnhancedDocument getAnonymousEnhancedDocument() {
             @Override
             public List<?> getList(String attributeName) {return null;}
             @Override
-            public <T> Map<String, T> getMap(String attributeName, EnhancedType<T> type) {return null;}
+            public <T> Map<String, T> getMapOfType(String attributeName, EnhancedType<T> type) {return null;}
             @Override
             public <T extends Number> Map<String, T> getMapOfNumbers(String attributeName, Class<T> valueType) {return null;}
             @Override
@@ -196,10 +196,9 @@ private static EnhancedDocument getAnonymousEnhancedDocument() {
             public EnhancedDocument getMapAsDocument(String attributeName) {return null;}
             @Override
             public String getJson(String attributeName) {return null;}
+
             @Override
-            public String getJsonPretty(String attributeName) {return null;}
-            @Override
-            public Boolean getBoolean(String attributeName) {return null;}
+            public boolean getBoolean(String attributeName) {return false;}
             @Override
             public Object get(String attributeName) {return null;}
             @Override