diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/config/MongoConfigurationSupport.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/config/MongoConfigurationSupport.java index 73028422b..aa49e49df 100644 --- a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/config/MongoConfigurationSupport.java +++ b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/config/MongoConfigurationSupport.java @@ -206,7 +206,7 @@ public abstract class MongoConfigurationSupport { * {@link org.springframework.data.mongodb.core.index.IndexDefinition} from the entity or not. * * @return {@literal false} by default.
- * INFO: As of 3.x the default is set to {@literal false}; In 2.x it was {@literal true}. + * INFO: As of 3.x the default is set to {@literal false}; In 2.x it was {@literal true}. * @since 2.2 */ protected boolean autoIndexCreation() { diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/CollectionOptions.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/CollectionOptions.java index c68acbf9b..372ffe5a3 100644 --- a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/CollectionOptions.java +++ b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/CollectionOptions.java @@ -114,7 +114,7 @@ public class CollectionOptions { /** * Create new {@link CollectionOptions} with already given settings and capped set to {@literal true}.
- * NOTE Using capped collections requires defining {@link #size(long)}. + * NOTE: Using capped collections requires defining {@link #size(long)}. * * @return new {@link CollectionOptions}. * @since 2.0 diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/ExecutableRemoveOperation.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/ExecutableRemoveOperation.java index aabd64d3a..e06394ca6 100644 --- a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/ExecutableRemoveOperation.java +++ b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/ExecutableRemoveOperation.java @@ -76,7 +76,7 @@ public interface ExecutableRemoveOperation { /** * Remove and return all matching documents.
- * NOTE The entire list of documents will be fetched before sending the actual delete commands. + * NOTE: The entire list of documents will be fetched before sending the actual delete commands. * Also, {@link org.springframework.context.ApplicationEvent}s will be published for each and every delete * operation. * diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/ReactiveRemoveOperation.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/ReactiveRemoveOperation.java index bf992e94b..275d56e74 100644 --- a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/ReactiveRemoveOperation.java +++ b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/ReactiveRemoveOperation.java @@ -69,7 +69,7 @@ public interface ReactiveRemoveOperation { /** * Remove and return all matching documents.
- * NOTE The entire list of documents will be fetched before sending the actual delete commands. + * NOTE: The entire list of documents will be fetched before sending the actual delete commands. * Also, {@link org.springframework.context.ApplicationEvent}s will be published for each and every delete * operation. * diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/DateOperators.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/DateOperators.java index ef0c75da7..f1dfddcb6 100644 --- a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/DateOperators.java +++ b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/DateOperators.java @@ -159,7 +159,7 @@ public class DateOperators { * +/-[hh], e.g. "+03" * * - * NOTE: Support for timezones in aggregations Requires MongoDB 3.6 or later. + * NOTE: Support for timezones in aggregations Requires MongoDB 3.6 or later. * * @author Christoph Strobl * @author Mark Paluch diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/convert/LazyLoadingProxyFactory.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/convert/LazyLoadingProxyFactory.java index 469c04236..e586f5ff5 100644 --- a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/convert/LazyLoadingProxyFactory.java +++ b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/convert/LazyLoadingProxyFactory.java @@ -47,7 +47,7 @@ import com.mongodb.DBRef; /** * {@link ProxyFactory} to create a proxy for {@link MongoPersistentProperty#getType()} to resolve a reference lazily. - * NOTE This class is intended for internal usage only. + * NOTE: This class is intended for internal usage only. * * @author Christoph Strobl * @author Mark Paluch diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/index/TextIndexDefinition.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/index/TextIndexDefinition.java index bdbf312a0..a22cf4eed 100644 --- a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/index/TextIndexDefinition.java +++ b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/index/TextIndexDefinition.java @@ -244,7 +244,7 @@ public class TextIndexDefinition implements IndexDefinition { /** * Define the index to span all fields using wildcard.
- * NOTE {@link TextIndexDefinition} cannot contain any other fields when defined with wildcard. + * NOTE: {@link TextIndexDefinition} cannot contain any other fields when defined with wildcard. * * @return */ diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/index/WildcardIndex.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/index/WildcardIndex.java index 5fa8ba8a7..f7b86b322 100644 --- a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/index/WildcardIndex.java +++ b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/index/WildcardIndex.java @@ -61,7 +61,7 @@ public class WildcardIndex extends Index { /** * Create a new instance of {@link WildcardIndex} for the given {@literal path}. If no {@literal path} is provided the * index will be considered a root one using {@code $**}.
- * NOTE {@link #wildcardProjectionInclude(String...)}, {@link #wildcardProjectionExclude(String...)} + * NOTE: {@link #wildcardProjectionInclude(String...)}, {@link #wildcardProjectionExclude(String...)} * can only be used for top level index definitions having an {@literal empty} or {@literal null} path. * * @param path can be {@literal null}. If {@literal null} all fields will be indexed. diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/index/WildcardIndexed.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/index/WildcardIndexed.java index 8121d77db..ddcc14ae3 100644 --- a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/index/WildcardIndexed.java +++ b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/index/WildcardIndexed.java @@ -119,7 +119,7 @@ public @interface WildcardIndexed { /** * Explicitly specify sub fields to be in-/excluded as a {@link org.bson.Document#parse(String) prasable} String. *
- * NOTE: Can only be applied on root level documents. + * NOTE: Can only be applied on root level documents. * * @return empty by default. */ diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/mapping/Field.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/mapping/Field.java index ed1d4ee43..2f74b0e9f 100644 --- a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/mapping/Field.java +++ b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/mapping/Field.java @@ -72,7 +72,7 @@ public @interface Field { * {@literal null} values are not written to the target {@code Document}. Setting the value to {@link Write#ALWAYS} * explicitly adds an entry for the given field holding {@literal null} as a value {@code 'fieldName' : null }. *
- * NOTESetting the value to {@link Write#ALWAYS} may lead to increased document size. + * NOTE: Setting the value to {@link Write#ALWAYS} may lead to increased document size. * * @return {@link Write#NON_NULL} by default. * @since 3.3 diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/mapping/MongoMappingContext.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/mapping/MongoMappingContext.java index 599c17ba7..2877b1ba4 100644 --- a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/mapping/MongoMappingContext.java +++ b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/mapping/MongoMappingContext.java @@ -97,11 +97,11 @@ public class MongoMappingContext extends AbstractMappingContext - * NOTE:Index creation should happen at a well-defined time that is ideally controlled by the + * NOTE: Index creation should happen at a well-defined time that is ideally controlled by the * application itself. * * @return {@literal true} when auto-index creation is enabled; {@literal false} otherwise.
- * INFO: As of 3.x the default will is set to {@literal false} was {@literal true} in 2.x. + * INFO: As of 3.x the default will is set to {@literal false} was {@literal true} in 2.x. * @since 2.2 * @see org.springframework.data.mongodb.core.index.Indexed */ diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/mapping/Sharded.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/mapping/Sharded.java index 13320f87b..063ec8b1c 100644 --- a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/mapping/Sharded.java +++ b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/mapping/Sharded.java @@ -64,7 +64,7 @@ public @interface Sharded { * is either a single or multiple indexed properties that exist in every document in the collection. *
* By default the {@literal id} property is used for sharding.
- * NOTE Required indexes are not created automatically. Create these either externally, via + * NOTE: Required indexes are not created automatically. Create these either externally, via * {@link org.springframework.data.mongodb.core.index.IndexOperations#ensureIndex(org.springframework.data.mongodb.core.index.IndexDefinition)} * or by annotating your domain model with {@link org.springframework.data.mongodb.core.index.Indexed}/ * {@link org.springframework.data.mongodb.core.index.CompoundIndex} along with enabled diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/query/NearQuery.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/query/NearQuery.java index 94fc854e9..c51a1ca44 100644 --- a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/query/NearQuery.java +++ b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/query/NearQuery.java @@ -232,7 +232,7 @@ public final class NearQuery implements ReadConcernAware, ReadPreferenceAware { /** * Creates a new {@link NearQuery} starting at the given {@link Point}.
- * NOTE There is a difference in using {@link Point} versus {@link GeoJsonPoint}. {@link Point} + * NOTE: There is a difference in using {@link Point} versus {@link GeoJsonPoint}. {@link Point} * values are rendered as coordinate pairs in the legacy format and operate upon radians, whereas the * {@link GeoJsonPoint} uses according to its specification {@literal meters} as unit of measure. This may lead to * different results when using a {@link Metrics#NEUTRAL neutral Metric}. @@ -248,7 +248,7 @@ public final class NearQuery implements ReadConcernAware, ReadPreferenceAware { * Creates a {@link NearQuery} starting near the given {@link Point} using the given {@link Metric} to adapt given * values to further configuration. E.g. setting a {@link #maxDistance(double)} will be interpreted as a value of the * initially set {@link Metric}.
- * NOTE There is a difference in using {@link Point} versus {@link GeoJsonPoint}. {@link Point} + * NOTE: There is a difference in using {@link Point} versus {@link GeoJsonPoint}. {@link Point} * values are rendered as coordinate pairs in the legacy format and operate upon radians, whereas the * {@link GeoJsonPoint} uses according to its specification {@literal meters} as unit of measure. This may lead to * different results when using a {@link Metrics#NEUTRAL neutral Metric}. diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/gridfs/ReactiveGridFsOperations.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/gridfs/ReactiveGridFsOperations.java index 924b86234..cca47650c 100644 --- a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/gridfs/ReactiveGridFsOperations.java +++ b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/gridfs/ReactiveGridFsOperations.java @@ -173,7 +173,7 @@ public interface ReactiveGridFsOperations { /** * Returns a {@link Flux} emitting all files matching the given query.
- * Note: Currently {@link Sort} criteria defined at the {@link Query} will not be regarded as MongoDB + * NOTE: Currently {@link Sort} criteria defined at the {@link Query} will not be regarded as MongoDB * does not support ordering for GridFS file access. * * @see MongoDB Jira: JAVA-431 @@ -185,7 +185,7 @@ public interface ReactiveGridFsOperations { /** * Returns a {@link Mono} emitting a single {@link com.mongodb.client.gridfs.model.GridFSFile} matching the given * query or {@link Mono#empty()} in case no file matches.
- * NOTE If more than one file matches the given query the resulting {@link Mono} emits an error. If + * NOTE: If more than one file matches the given query the resulting {@link Mono} emits an error. If * you want to obtain the first found file use {@link #findFirst(Query)}. * * @param query must not be {@literal null}. diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/gridfs/ReactiveGridFsResource.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/gridfs/ReactiveGridFsResource.java index 7578dba37..4c325227c 100644 --- a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/gridfs/ReactiveGridFsResource.java +++ b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/gridfs/ReactiveGridFsResource.java @@ -136,7 +136,7 @@ public class ReactiveGridFsResource implements GridFsObject - * NOTE Buffers data in memory. Use {@link #getDownloadStream()} for large files. + * NOTE: Buffers data in memory. Use {@link #getDownloadStream()} for large files. * * @throws IllegalStateException if the underlying {@link Publisher} has already been consumed. * @see org.springframework.core.io.InputStreamResource#getInputStream()