mindol1004/spring-data-mongodb
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Polishing.

Browse Source 
Tweak Javadoc, make ViewOptions.collation final.

See: #2594
Original pull request: #4142.
This commit is contained in:
Mark Paluch
2022-09-14 11:22:23 +02:00
parent 77f318bd77
commit 81f85b8cca
4 changed files with 26 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -283,9 +283,9 @@ public interface MongoOperations extends FluentMongoOperations {
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 @@ public interface MongoOperations extends FluentMongoOperations {
}
/**
* 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 @@ public interface MongoOperations extends FluentMongoOperations {
}
/**
* 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 @@ public interface MongoOperations extends FluentMongoOperations {
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 @@ public interface MongoOperations extends FluentMongoOperations {
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 @@ public interface MongoOperations extends FluentMongoOperations {
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 @@ public interface MongoOperations extends FluentMongoOperations {
<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.

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

@@ -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 java.util.function.Supplier;
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 @@ public interface ReactiveMongoOperations extends ReactiveFluentMongoOperations {
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 @@ public interface ReactiveMongoOperations extends ReactiveFluentMongoOperations {
}
/**
* 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 @@ public interface ReactiveMongoOperations extends ReactiveFluentMongoOperations {
}
/**
* 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 @@ public interface ReactiveMongoOperations extends ReactiveFluentMongoOperations {
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 @@ public interface ReactiveMongoOperations extends ReactiveFluentMongoOperations {
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 @@ public interface ReactiveMongoOperations extends ReactiveFluentMongoOperations {
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 @@ public interface ReactiveMongoOperations extends ReactiveFluentMongoOperations {
<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.

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

@@ -23,13 +23,13 @@ import org.springframework.lang.Nullable;
/**
* 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();

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

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