Documentation updates

Author: boostchicken

pom.xml

@@ -297,6 +297,7 @@
                     </properties>
                     <excludes>
                         <exclude>**/README.md</exclude>
+                        <exclude>**/FUNDING.yml</exclude>
                         <exclude>**/DONATION.md</exclude>
                         <exclude>**/CONTRIBUTING.md</exclude>
                         <exclude>**/LICENSE</exclude>
@@ -608,7 +609,7 @@
                     <plugin>
                         <groupId>org.apache.maven.plugins</groupId>
                         <artifactId>maven-javadoc-plugin</artifactId>
-                        <version>3.0.0</version>
+                        <version>3.1.1</version>
                         <executions>
                             <execution>
                                 <id>attach-javadocs</id>
@@ -791,7 +792,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-javadoc-plugin</artifactId>
-                <version>3.0.0</version>
+                <version>3.1.1</version>
                 <reportSets>
                     <reportSet>
                         <id>default</id>
@@ -805,7 +806,7 @@
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-checkstyle-plugin</artifactId>
                 <configuration>
-                    <configLocation>checkstyle.xml</configLocation>
+                    <configLocation>src/checkstyle.xml</configLocation>
                 </configuration>
             </plugin>
             <plugin>

src/main/java/org/socialsignin/spring/data/dynamodb/core/DynamoDBTemplate.java

@@ -28,8 +28,6 @@
 import com.amazonaws.services.dynamodbv2.model.QueryRequest;
 import com.amazonaws.services.dynamodbv2.model.QueryResult;
 import com.amazonaws.services.dynamodbv2.model.Select;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 import org.socialsignin.spring.data.dynamodb.mapping.event.AfterDeleteEvent;
 import org.socialsignin.spring.data.dynamodb.mapping.event.AfterLoadEvent;
 import org.socialsignin.spring.data.dynamodb.mapping.event.AfterQueryEvent;
@@ -52,7 +50,6 @@
 import java.util.stream.Collectors;
 
 public class DynamoDBTemplate implements DynamoDBOperations, ApplicationContextAware {
-	private static final Logger LOGGER = LoggerFactory.getLogger(DynamoDBTemplate.class);
 	private final DynamoDBMapper dynamoDBMapper;
 	private final AmazonDynamoDB amazonDynamoDB;
 	private final DynamoDBMapperConfig dynamoDBMapperConfig;
@@ -71,7 +68,6 @@ public class DynamoDBTemplate implements DynamoDBOperations, ApplicationContextA
 	 *            can be {@code null} -
 	 *            {@link DynamoDBMapper#DynamoDBMapper(AmazonDynamoDB, DynamoDBMapperConfig)}
 	 *            is used if {@code null} is passed in
-	 * @param dynamoDBMapperConfig
 	 */
 	@Autowired
 	public DynamoDBTemplate(AmazonDynamoDB amazonDynamoDB, DynamoDBMapper dynamoDBMapper,

src/main/java/org/socialsignin/spring/data/dynamodb/repository/Query.java

@@ -36,6 +36,7 @@
 	 * @see <a href=
 	 *      "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ProjectionExpressions.html">Projection
 	 *      Expressions</a>
+	 * @return comma-separated list of fields
 	 */
 	String fields() default "";
 
@@ -45,9 +46,18 @@
 	 * @see <a href=
 	 *      "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ProjectionExpressions.html">Projection
 	 *      Expressions</a>
+	 * @return number of results to return
 	 */
 	int limit() default QUERY_LIMIT_UNLIMITED;
 
-
+	/**
+	 * Override consistent read mode set in the DynamoDBMapper
+	 *
+	 * @see <a href=
+	 *      "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html">Read Consistency</a>
+	 * @see <a href=
+	 *      "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBMapper.OptionalConfig.html">DynamoDBMapper Configuration</a>
+	 * @return ConistentReadMode to enforce on query
+	 */
 	ConsistentReadMode consistentReads() default ConsistentReadMode.DEFAULT;
 }

src/main/java/org/socialsignin/spring/data/dynamodb/repository/QueryConstants.java

@@ -23,8 +23,28 @@ private QueryConstants() {
 	public static final int QUERY_LIMIT_UNLIMITED = Integer.MIN_VALUE;
 
 	public enum ConsistentReadMode {
+		/**
+		 * Use the default configured in the DynamoDBMapper
+		 * @see com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBMapperConfig
+		 * @see <a href=
+		 *      "https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBMapper.OptionalConfig.html">DynamoDBMapper Configuration</a>
+		 *
+		 */
 		DEFAULT,
+		/**
+		 * Set consistent read mode to true
+		 * @see <a href=
+		 *      "https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/dynamodbv2/datamodeling/DynamoDBQueryExpression.html#setConsistentRead-boolean-">Consistent Reads</a>
+		 * @see com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBQueryExpression#setConsistentRead(boolean)
+		 */
 		CONSISTENT,
+		/**
+		 * Set consistent read mode to false
+		 * @see <a href=
+		 *      "https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/dynamodbv2/datamodeling/DynamoDBQueryExpression.html#setConsistentRead-boolean-">Consistent Reads</a>
+		 *
+		 * @see com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBQueryExpression#setConsistentRead(boolean)
+		 */
 		EVENTUAL
 	}
 }