DATAMONGO-1563 - Polishing.

Rename TerminatingAggregationOperation.get() to TerminatingAggregationOperation.all() to name methods consistently. Extract collection name retrieval to method. Javadoc, formatting, add generics where required/use diamond syntax where applicable.

Original pull request: #466.

Author: mp911de

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/ExecutableAggregationOperation.java

@@ -36,6 +36,7 @@
  * </pre>
  *
  * @author Christoph Strobl
+ * @author Mark Paluch
  * @since 2.0
  */
 public interface ExecutableAggregationOperation {
@@ -54,7 +55,6 @@ public interface ExecutableAggregationOperation {
 	/**
 	 * Collection override (Optional).
 	 *
-	 * @param <T>
 	 * @author Christoph Strobl
 	 * @since 2.0
 	 */
@@ -74,19 +74,20 @@ interface AggregationOperationWithCollection<T> {
 	/**
 	 * Trigger execution by calling one of the terminating methods.
 	 *
-	 * @param <T>
+	 * @author Christoph Strobl
+	 * @since 2.0
 	 */
 	interface TerminatingAggregationOperation<T> {
 
 		/**
-		 * Apply pipeline operations as specified.
+		 * Apply pipeline operations as specified and get all matching elements.
 		 *
 		 * @return never {@literal null}.
 		 */
-		AggregationResults<T> get();
+		AggregationResults<T> all();
 
 		/**
-		 * Apply pipeline operations as specified. <br />
+		 * Apply pipeline operations as specified and stream all matching elements. <br />
 		 * Returns a {@link CloseableIterator} that wraps the a Mongo DB {@link com.mongodb.Cursor}
 		 *
 		 * @return a {@link CloseableIterator} that wraps the a Mongo DB {@link com.mongodb.Cursor} that needs to be closed.
@@ -98,7 +99,6 @@ interface TerminatingAggregationOperation<T> {
 	/**
 	 * Define the aggregation with pipeline stages.
 	 *
-	 * @param <T>
 	 * @author Christoph Strobl
 	 * @since 2.0
 	 */
@@ -115,7 +115,6 @@ interface AggregationOperationWithAggregation<T> {
 	}
 
 	/**
-	 * @param <T>
 	 * @author Christoph Strobl
 	 * @since 2.0
 	 */

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/ExecutableAggregationOperationSupport.java

@@ -35,26 +35,27 @@ class ExecutableAggregationOperationSupport implements ExecutableAggregationOper
 	private final MongoTemplate template;
 
 	/**
-	 * Create new instance of ExecutableAggregationOperationSupport.
+	 * Create new instance of {@link ExecutableAggregationOperationSupport}.
 	 *
 	 * @param template must not be {@literal null}.
 	 * @throws IllegalArgumentException if template is {@literal null}.
 	 */
 	ExecutableAggregationOperationSupport(MongoTemplate template) {
 
 		Assert.notNull(template, "Template must not be null!");
+
 		this.template = template;
 	}
 
 	@Override
 	public <T> AggregationOperation<T> aggregateAndReturn(Class<T> domainType) {
 
 		Assert.notNull(domainType, "DomainType must not be null!");
-		return new AggregationOperationSupport<T>(template, null, domainType, null);
+
+		return new AggregationOperationSupport<>(template, null, domainType, null);
 	}
 
 	/**
-	 * @param <T>
 	 * @author Christoph Strobl
 	 * @since 2.0
 	 */
@@ -71,18 +72,20 @@ static class AggregationOperationSupport<T>
 		public AggregationOperationWithAggregation<T> inCollection(String collection) {
 
 			Assert.hasText(collection, "Collection must not be null nor empty!");
-			return new AggregationOperationSupport<T>(template, aggregation, domainType, collection);
+
+			return new AggregationOperationSupport<>(template, aggregation, domainType, collection);
 		}
 
 		@Override
 		public TerminatingAggregationOperation<T> by(Aggregation aggregation) {
 
 			Assert.notNull(aggregation, "Aggregation must not be null!");
-			return new AggregationOperationSupport<T>(template, aggregation, domainType, collection);
+
+			return new AggregationOperationSupport<>(template, aggregation, domainType, collection);
 		}
 
 		@Override
-		public AggregationResults<T> get() {
+		public AggregationResults<T> all() {
 			return template.aggregate(aggregation, getCollectionName(aggregation), domainType);
 		}
 
@@ -99,8 +102,10 @@ private String getCollectionName(Aggregation aggregation) {
 
 			if (aggregation instanceof TypedAggregation) {
 
-				if (((TypedAggregation<?>) aggregation).getInputType() != null) {
-					return template.determineCollectionName(((TypedAggregation<?>) aggregation).getInputType());
+				TypedAggregation<?> typedAggregation = (TypedAggregation<?>) aggregation;
+
+				if (typedAggregation.getInputType() != null) {
+					return template.determineCollectionName(typedAggregation.getInputType());
 				}
 			}
 

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/ExecutableFindOperation.java

@@ -27,9 +27,9 @@
  * {@link ExecutableFindOperation} allows creation and execution of MongoDB find operations in a fluent API style.
  * <br />
  * The starting {@literal domainType} is used for mapping the {@link Query} provided via {@code matching} into the
- * MongoDB specific representation. By default this originating {@literal domainType} is also used for mapping back the
- * result from the {@link org.bson.Document}. However it is possible to define an different {@literal returnType} via
- * {@code as} that is then used for mapping the result mapping. <br />
+ * MongoDB specific representation. By default, the originating {@literal domainType} is also used for mapping back the
+ * result from the {@link org.bson.Document}. However, it is possible to define an different {@literal returnType} via
+ * {@code as} to mapping the result.<br />
  * The collection to operate on is by default derived from the initial {@literal domainType} and can be defined there
  * via {@link org.springframework.data.mongodb.core.mapping.Document}. Using {@code inCollection} allows to override the
  * collection name for the execution.
@@ -45,6 +45,7 @@
  * </pre>
  *
  * @author Christoph Strobl
+ * @author Mark Paluch
  * @since 2.0
  */
 public interface ExecutableFindOperation {
@@ -61,7 +62,6 @@ public interface ExecutableFindOperation {
 	/**
 	 * Trigger find execution by calling one of the terminating methods.
 	 *
-	 * @param <T>
 	 * @author Christoph Strobl
 	 * @since 2.0
 	 */
@@ -85,7 +85,7 @@ interface TerminatingFindOperation<T> {
 		/**
 		 * Get all matching elements.
 		 *
-		 * @return never {@literal}.
+		 * @return never {@literal null}.
 		 */
 		List<T> all();
 
@@ -101,7 +101,6 @@ interface TerminatingFindOperation<T> {
 	/**
 	 * Trigger geonear execution by calling one of the terminating methods.
 	 *
-	 * @param <T>
 	 * @author Christoph Strobl
 	 * @since 2.0
 	 */
@@ -118,7 +117,6 @@ interface TerminatingFindNearOperation<T> {
 	/**
 	 * Terminating operations invoking the actual query execution.
 	 *
-	 * @param <T>
 	 * @author Christoph Strobl
 	 * @since 2.0
 	 */
@@ -146,7 +144,6 @@ interface FindOperationWithQuery<T> extends TerminatingFindOperation<T> {
 	/**
 	 * Collection override (Optional).
 	 *
-	 * @param <T>
 	 * @author Christoph Strobl
 	 * @since 2.0
 	 */
@@ -166,7 +163,6 @@ interface FindOperationWithCollection<T> extends FindOperationWithQuery<T> {
 	/**
 	 * Result type override (Optional).
 	 *
-	 * @param <T>
 	 * @author Christoph Strobl
 	 * @since 2.0
 	 */
@@ -187,11 +183,8 @@ interface FindOperationWithProjection<T> extends FindOperationWithQuery<T> {
 	/**
 	 * {@link FindOperation} provides methods for constructing lookup operations in a fluent way.
 	 *
-	 * @param <T>
 	 * @author Christoph Strobl
 	 * @since 2.0
 	 */
-	interface FindOperation<T> extends FindOperationWithCollection<T>, FindOperationWithProjection<T> {
-
-	}
+	interface FindOperation<T> extends FindOperationWithCollection<T>, FindOperationWithProjection<T> {}
 }

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/ExecutableFindOperationSupport.java

@@ -123,6 +123,7 @@ public Optional<T> one() {
 		public Optional<T> first() {
 
 			List<T> result = doFind(new DelegatingQueryCursorPreparer(getCursorPreparer(query, null)).limit(1));
+
 			return ObjectUtils.isEmpty(result) ? Optional.empty() : Optional.of(result.iterator().next());
 		}
 
@@ -170,7 +171,6 @@ private String asString() {
 	}
 
 	/**
-	 * @param <T>
 	 * @author Christoph Strobl
 	 * @since 2.0
 	 */
@@ -179,15 +179,16 @@ static class DelegatingQueryCursorPreparer implements CursorPreparer {
 		private final CursorPreparer delegate;
 		private Optional<Integer> limit = Optional.empty();
 
-		public DelegatingQueryCursorPreparer(CursorPreparer delegate) {
+		DelegatingQueryCursorPreparer(CursorPreparer delegate) {
 			this.delegate = delegate;
 		}
 
 		@Override
 		public FindIterable<Document> prepare(FindIterable<Document> cursor) {
 
 			FindIterable<Document> target = delegate.prepare(cursor);
-			return limit.map(it -> target.limit(it)).orElse(target);
+
+			return limit.map(target::limit).orElse(target);
 		}
 
 		CursorPreparer limit(int limit) {

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/ExecutableInsertOperation.java

@@ -22,7 +22,7 @@
 import com.mongodb.bulk.BulkWriteResult;
 
 /**
- * {@link ExecutableFindOperation} allows creation and execution of MongoDB insert and bulk insert operations in a
+ * {@link ExecutableInsertOperation} allows creation and execution of MongoDB insert and bulk insert operations in a
  * fluent API style. <br />
  * The collection to operate on is by default derived from the initial {@literal domainType} and can be defined there
  * via {@link org.springframework.data.mongodb.core.mapping.Document}. Using {@code inCollection} allows to override the
@@ -53,7 +53,6 @@ public interface ExecutableInsertOperation {
 	/**
 	 * Trigger insert execution by calling one of the terminating methods.
 	 *
-	 * @param <T>
 	 * @author Christoph Strobl
 	 * @since 2.0
 	 */
@@ -79,7 +78,6 @@ interface TerminatingInsertOperation<T> extends TerminatingBulkInsertOperation<T
 	/**
 	 * Trigger bulk insert execution by calling one of the terminating methods.
 	 *
-	 * @param <T>
 	 * @author Christoph Strobl
 	 * @since 2.0
 	 */
@@ -96,19 +94,15 @@ interface TerminatingBulkInsertOperation<T> {
 	}
 
 	/**
-	 * @param <T>
 	 * @author Christoph Strobl
 	 * @since 2.0
 	 */
 	interface InsertOperation<T>
-			extends TerminatingInsertOperation<T>, InsertOperationWithCollection<T>, InsertOperationWithBulkMode<T> {
-
-	}
+			extends TerminatingInsertOperation<T>, InsertOperationWithCollection<T>, InsertOperationWithBulkMode<T> {}
 
 	/**
 	 * Collection override (Optional).
 	 *
-	 * @param <T>
 	 * @author Christoph Strobl
 	 * @since 2.0
 	 */
@@ -126,7 +120,6 @@ interface InsertOperationWithCollection<T> {
 	}
 
 	/**
-	 * @param <T>
 	 * @author Christoph Strobl
 	 * @since 2.0
 	 */
@@ -135,7 +128,7 @@ interface InsertOperationWithBulkMode<T> extends TerminatingInsertOperation<T> {
 		/**
 		 * Define the {@link BulkMode} to use for bulk insert operation.
 		 *
-		 * @param mode must not be {@literal null}.
+		 * @param bulkMode must not be {@literal null}.
 		 * @return new instance of {@link TerminatingBulkInsertOperation}.
 		 * @throws IllegalArgumentException if bulkMode is {@literal null}.
 		 */

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/ExecutableInsertOperationSupport.java

@@ -53,11 +53,11 @@ class ExecutableInsertOperationSupport implements ExecutableInsertOperation {
 	public <T> InsertOperation<T> insert(Class<T> domainType) {
 
 		Assert.notNull(domainType, "DomainType must not be null!");
-		return new InsertOperationSupport<T>(template, domainType, null, null);
+
+		return new InsertOperationSupport<>(template, domainType, null, null);
 	}
 
 	/**
-	 * @param <T>
 	 * @author Christoph Strobl
 	 * @since 2.0
 	 */
@@ -73,41 +73,45 @@ static class InsertOperationSupport<T> implements InsertOperation<T> {
 		public void one(T object) {
 
 			Assert.notNull(object, "Object must not be null!");
+
 			template.insert(object, getCollectionName());
 		}
 
 		@Override
 		public void all(Collection<? extends T> objects) {
 
 			Assert.notNull(objects, "Objects must not be null!");
+
 			template.insert(objects, getCollectionName());
 		}
 
 		@Override
 		public BulkWriteResult bulk(Collection<? extends T> objects) {
 
 			Assert.notNull(objects, "Objects must not be null!");
+
 			return template.bulkOps(bulkMode != null ? bulkMode : BulkMode.ORDERED, domainType, getCollectionName())
 					.insert(new ArrayList<>(objects)).execute();
 		}
 
 		@Override
-		public InsertOperationWithBulkMode inCollection(String collection) {
+		public InsertOperationWithBulkMode<T> inCollection(String collection) {
 
 			Assert.hasText(collection, "Collection must not be null nor empty.");
-			return new InsertOperationSupport<T>(template, domainType, collection, bulkMode);
+
+			return new InsertOperationSupport<>(template, domainType, collection, bulkMode);
 		}
 
 		@Override
-		public TerminatingBulkInsertOperation withBulkMode(BulkMode bulkMode) {
+		public TerminatingBulkInsertOperation<T> withBulkMode(BulkMode bulkMode) {
 
 			Assert.notNull(bulkMode, "BulkMode must not be null!");
-			return new InsertOperationSupport<T>(template, domainType, collection, bulkMode);
+
+			return new InsertOperationSupport<>(template, domainType, collection, bulkMode);
 		}
 
 		private String getCollectionName() {
 			return StringUtils.hasText(collection) ? collection : template.determineCollectionName(domainType);
 		}
-
 	}
 }