Polishing.

Tweak Javadoc, make ViewOptions.collation final.

See: #2594
Original pull request: #4142.

Author: mp911de

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

@@ -283,9 +283,9 @@ public <T> T execute(SessionCallback<T> action, Consumer<ClientSession> onComple
 	MongoCollection<Document> createCollection(String collectionName, @Nullable CollectionOptions collectionOptions);
 
 	/**
-	 * Create a view with the the provided name whose contents are defined by the {@link AggregationOperation pipeline
+	 * Create a view with the provided name. The view content is defined by the {@link AggregationOperation pipeline
 	 * stages} on another collection or view identified by the given {@link #getCollectionName(Class) source type}.
-	 * 
+	 *
 	 * @param name the name of the view to create.
 	 * @param source the type defining the views source collection.
 	 * @param stages the {@link AggregationOperation aggregation pipeline stages} defining the view content.
@@ -296,7 +296,7 @@ default MongoCollection<Document> createView(String name, Class<?> source, Aggre
 	}
 
 	/**
-	 * Create a view with the the provided name whose contents are defined by the  {@link AggregationPipeline pipeline} on
+	 * Create a view with the provided name. The view content is defined by the {@link AggregationPipeline pipeline} on
 	 * another collection or view identified by the given {@link #getCollectionName(Class) source type}.
 	 *
 	 * @param name the name of the view to create.
@@ -309,7 +309,7 @@ default MongoCollection<Document> createView(String name, Class<?> source, Aggre
 	}
 
 	/**
-	 * Create a view with the the provided name whose contents are defined by the {@link AggregationPipeline pipeline} on
+	 * Create a view with the provided name. The view content is defined by the {@link AggregationPipeline pipeline} on
 	 * another collection or view identified by the given {@link #getCollectionName(Class) source type}.
 	 *
 	 * @param name the name of the view to create.
@@ -321,7 +321,7 @@ default MongoCollection<Document> createView(String name, Class<?> source, Aggre
 	MongoCollection<Document> createView(String name, Class<?> source, AggregationPipeline pipeline, @Nullable ViewOptions options);
 
 	/**
-	 * Create a view with the the provided name whose contents are defined by the {@link AggregationPipeline pipeline} on
+	 * Create a view with the provided name. The view content is defined by the {@link AggregationPipeline pipeline} on
 	 * another collection or view identified by the given source.
 	 *
 	 * @param name the name of the view to create.
@@ -1593,7 +1593,7 @@ default long exactCount(Query query, String collectionName) {
 	DeleteResult remove(Object object, String collectionName);
 
 	/**
-	 * Remove all documents that match the provided query document criteria from the the collection used to store the
+	 * Remove all documents that match the provided query document criteria from the collection used to store the
 	 * entityClass. The Class parameter is also used to help convert the Id of the object if it is present in the query.
 	 *
 	 * @param query the query document that specifies the criteria used to remove a record.
@@ -1604,7 +1604,7 @@ default long exactCount(Query query, String collectionName) {
 	DeleteResult remove(Query query, Class<?> entityClass);
 
 	/**
-	 * Remove all documents that match the provided query document criteria from the the collection used to store the
+	 * Remove all documents that match the provided query document criteria from the collection used to store the
 	 * entityClass. The Class parameter is also used to help convert the Id of the object if it is present in the query.
 	 *
 	 * @param query the query document that specifies the criteria used to remove a record.
@@ -1652,9 +1652,9 @@ default long exactCount(Query query, String collectionName) {
 	<T> List<T> findAllAndRemove(Query query, Class<T> entityClass);
 
 	/**
-	 * Returns and removes all documents that match the provided query document criteria from the the collection used to
-	 * store the entityClass. The Class parameter is also used to help convert the Id of the object if it is present in
-	 * the query.
+	 * Returns and removes all documents that match the provided query document criteria from the collection used to store
+	 * the entityClass. The Class parameter is also used to help convert the Id of the object if it is present in the
+	 * query.
 	 *
 	 * @param query the query document that specifies the criteria used to find and remove documents.
 	 * @param entityClass class of the pojo to be operated on.

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

@@ -15,8 +15,6 @@
  */
 package org.springframework.data.mongodb.core;
 
-import org.springframework.data.mongodb.core.aggregation.AggregationOperation;
-import org.springframework.data.mongodb.core.aggregation.AggregationPipeline;
 import reactor.core.publisher.Flux;
 import reactor.core.publisher.Mono;
 
@@ -27,10 +25,13 @@
 import org.bson.Document;
 import org.reactivestreams.Publisher;
 import org.reactivestreams.Subscription;
+
 import org.springframework.data.geo.GeoResult;
 import org.springframework.data.mongodb.ReactiveMongoDatabaseFactory;
 import org.springframework.data.mongodb.core.aggregation.Aggregation;
+import org.springframework.data.mongodb.core.aggregation.AggregationOperation;
 import org.springframework.data.mongodb.core.aggregation.AggregationOptions;
+import org.springframework.data.mongodb.core.aggregation.AggregationPipeline;
 import org.springframework.data.mongodb.core.aggregation.AggregationUpdate;
 import org.springframework.data.mongodb.core.aggregation.TypedAggregation;
 import org.springframework.data.mongodb.core.convert.MappingMongoConverter;
@@ -243,7 +244,7 @@ <T> Mono<MongoCollection<Document>> createCollection(Class<T> entityClass,
 	Mono<MongoCollection<Document>> createCollection(String collectionName, CollectionOptions collectionOptions);
 
 	/**
-	 * Create a view with the the provided name whose contents are defined by the {@link AggregationOperation pipeline
+	 * Create a view with the provided name. The view content is defined by the {@link AggregationOperation pipeline
 	 * stages} on another collection or view identified by the given {@link #getCollectionName(Class) source type}.
 	 *
 	 * @param name the name of the view to create.
@@ -256,7 +257,7 @@ default Mono<MongoCollection<Document>> createView(String name, Class<?> source,
 	}
 
 	/**
-	 * Create a view with the the provided name whose contents are defined by the  {@link AggregationPipeline pipeline} on
+	 * Create a view with the provided name. The view content is defined by the {@link AggregationPipeline pipeline} on
 	 * another collection or view identified by the given {@link #getCollectionName(Class) source type}.
 	 *
 	 * @param name the name of the view to create.
@@ -269,7 +270,7 @@ default Mono<MongoCollection<Document>> createView(String name, Class<?> source,
 	}
 
 	/**
-	 * Create a view with the the provided name whose contents are defined by the {@link AggregationPipeline pipeline} on
+	 * Create a view with the provided name. The view content is defined by the {@link AggregationPipeline pipeline} on
 	 * another collection or view identified by the given {@link #getCollectionName(Class) source type}.
 	 *
 	 * @param name the name of the view to create.
@@ -281,7 +282,7 @@ default Mono<MongoCollection<Document>> createView(String name, Class<?> source,
 	Mono<MongoCollection<Document>> createView(String name, Class<?> source, AggregationPipeline pipeline, @Nullable ViewOptions options);
 
 	/**
-	 * Create a view with the the provided name whose contents are defined by the {@link AggregationPipeline pipeline} on
+	 * Create a view with the provided name. The view content is defined by the {@link AggregationPipeline pipeline} on
 	 * another collection or view identified by the given source.
 	 *
 	 * @param name the name of the view to create.
@@ -1445,7 +1446,7 @@ default Mono<Long> exactCount(Query query, String collectionName) {
 	Mono<DeleteResult> remove(Mono<? extends Object> objectToRemove, String collectionName);
 
 	/**
-	 * Remove all documents that match the provided query document criteria from the the collection used to store the
+	 * Remove all documents that match the provided query document criteria from the collection used to store the
 	 * entityClass. The Class parameter is also used to help convert the Id of the object if it is present in the query.
 	 *
 	 * @param query the query document that specifies the criteria used to remove a record.
@@ -1455,7 +1456,7 @@ default Mono<Long> exactCount(Query query, String collectionName) {
 	Mono<DeleteResult> remove(Query query, Class<?> entityClass);
 
 	/**
-	 * Remove all documents that match the provided query document criteria from the the collection used to store the
+	 * Remove all documents that match the provided query document criteria from the collection used to store the
 	 * entityClass. The Class parameter is also used to help convert the Id of the object if it is present in the query.
 	 *
 	 * @param query the query document that specifies the criteria used to remove a record.
@@ -1498,9 +1499,9 @@ default Mono<Long> exactCount(Query query, String collectionName) {
 	<T> Flux<T> findAllAndRemove(Query query, Class<T> entityClass);
 
 	/**
-	 * Returns and removes all documents that match the provided query document criteria from the the collection used to
-	 * store the entityClass. The Class parameter is also used to help convert the Id of the object if it is present in
-	 * the query.
+	 * Returns and removes all documents that match the provided query document criteria from the collection used to store
+	 * the entityClass. The Class parameter is also used to help convert the Id of the object if it is present in the
+	 * query.
 	 *
 	 * @param query the query document that specifies the criteria used to find and remove documents.
 	 * @param entityClass class of the pojo to be operated on.

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

@@ -23,13 +23,13 @@
 /**
  * Immutable object holding additional options to be applied when creating a MongoDB
  * <a href="https://www.mongodb.com/docs/manual/core/views/">views</a>.
- * 
+ *
  * @author Christoph Strobl
  * @since 4.0
  */
 public class ViewOptions {
 
-	@Nullable private Collation collation;
+	private final @Nullable Collation collation;
 
 	static ViewOptions none() {
 		return new ViewOptions();

spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/MongoTemplateViewTests.java

@@ -41,6 +41,8 @@
 import com.mongodb.client.MongoClient;
 
 /**
+ * Integration tests for Views.
+ *
  * @author Christoph Strobl
  */
 @ExtendWith(MongoClientExtension.class)