Javadoc for TableSchema::itemToMap method

[tkhill-AWS]

Describe the issue

We might want to clarify the description of the ignoreNulls parameter because it is not precise enough especially when the @DynamoDbIgnoreNulls attribute is thrown in the mix.

It current reads

ignoreNulls - If set to true; any null values in the Java object will not be added to the output map. If set to false; null values in the Java object will be added as AttributeValue of type 'nul' to the output map.

Perhaps change to

ignoreNulls - If set to true; any null, non-object (scalar) values in the Java object are not be added to the output map. If set to false; null, non-object (scalar) values in the Java object are added as AttributeValue of type 'nul' to the output map.

Object-type values (inner bean types)--if null--are output to the map either way. If @DynamoDBIgnoreNulls is used on the getter, an empty map is output; if there is no annotation on the getter, an attribute is created with 'nul' types for its (sub)attributes.

Links

https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/enhanced/dynamodb/TableSchema.html#itemToMap(T,boolean)

[tkhill-AWS]

Closing this issue because I was confused since I was also working with the @DynamoDbIgnoreNulls anno.

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.