DATAMONGO-2509 - Update Javadoc.

Original pull request: #853.

Author: christophstrobl

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/LazyLoadingException.java

@@ -25,8 +25,10 @@ public class LazyLoadingException extends UncategorizedDataAccessException {
 	private static final long serialVersionUID = -7089224903873220037L;
 
 	/**
-	 * @param msg
-	 * @param cause
+	 * Constructor for LazyLoadingException.
+	 *
+	 * @param msg the detail message.
+	 * @param cause the exception thrown by underlying data access API.
 	 */
 	public LazyLoadingException(String msg, Throwable cause) {
 		super(msg, cause);

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/MongoDatabaseFactory.java

@@ -45,7 +45,7 @@ public interface MongoDatabaseFactory extends CodecRegistryProvider, MongoSessio
 	/**
 	 * Obtain a {@link MongoDatabase} instance to access the database with the given name.
 	 *
-	 * @param dbName
+	 * @param dbName must not be {@literal null}.
 	 * @return never {@literal null}.
 	 * @throws DataAccessException
 	 */

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/MongoDbFactory.java

@@ -33,7 +33,7 @@ public interface MongoDbFactory extends MongoDatabaseFactory {
 	/**
 	 * Creates a default {@link MongoDatabase} instance.
 	 *
-	 * @return
+	 * @return never {@literal null}.
 	 * @throws DataAccessException
 	 * @deprecated since 3.0. Use {@link #getMongoDatabase()} instead.
 	 */
@@ -46,7 +46,7 @@ default MongoDatabase getDb() throws DataAccessException {
 	 * Obtain a {@link MongoDatabase} instance to access the database with the given name.
 	 *
 	 * @param dbName must not be {@literal null} or empty.
-	 * @return
+	 * @return never {@literal null}.
 	 * @throws DataAccessException
 	 * @deprecated since 3.0. Use {@link #getMongoDatabase(String)} instead.
 	 */

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/ReactiveMongoDatabaseFactory.java

@@ -39,7 +39,7 @@ public interface ReactiveMongoDatabaseFactory extends CodecRegistryProvider {
 	/**
 	 * Creates a default {@link MongoDatabase} instance.
 	 *
-	 * @return
+	 * @return never {@literal null}.
 	 * @throws DataAccessException
 	 */
 	Mono<MongoDatabase> getMongoDatabase() throws DataAccessException;
@@ -48,7 +48,7 @@ public interface ReactiveMongoDatabaseFactory extends CodecRegistryProvider {
 	 * Obtain a {@link MongoDatabase} instance to access the database with the given name.
 	 *
 	 * @param dbName must not be {@literal null} or empty.
-	 * @return
+	 * @return never {@literal null}.
 	 * @throws DataAccessException
 	 */
 	Mono<MongoDatabase> getMongoDatabase(String dbName) throws DataAccessException;

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/config/EnableMongoAuditing.java

@@ -42,29 +42,29 @@
 	/**
 	 * Configures the {@link AuditorAware} bean to be used to lookup the current principal.
 	 *
-	 * @return
+	 * @return empty {@link String} by default.
 	 */
 	String auditorAwareRef() default "";
 
 	/**
 	 * Configures whether the creation and modification dates are set. Defaults to {@literal true}.
 	 *
-	 * @return
+	 * @return {@literal true} by default.
 	 */
 	boolean setDates() default true;
 
 	/**
 	 * Configures whether the entity shall be marked as modified on creation. Defaults to {@literal true}.
 	 *
-	 * @return
+	 * @return {@literal true} by default.
 	 */
 	boolean modifyOnCreate() default true;
 
 	/**
 	 * Configures a {@link DateTimeProvider} bean name that allows customizing the {@link org.joda.time.DateTime} to be
 	 * used for setting creation and modification dates.
 	 *
-	 * @return
+	 * @return empty {@link String} by default.
 	 */
 	String dateTimeProviderRef() default "";
 }

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/config/MongoConfigurationSupport.java

@@ -95,7 +95,7 @@ public MongoMappingContext mongoMappingContext(MongoCustomConversions customConv
 	/**
 	 * Register custom {@link Converter}s in a {@link CustomConversions} object if required. These
 	 * {@link CustomConversions} will be registered with the
-	 * {@link org.springframework.data.mongodb.core.convert.MappingMongoConverter} and {@link #mongoMappingContext()}.
+	 * {@link org.springframework.data.mongodb.core.convert.MappingMongoConverter} and {@link MongoMappingContext}.
 	 * Returns an empty {@link MongoCustomConversions} instance by default.
 	 * <p>
 	 * <strong>NOTE:</strong> Use {@link #configureConverters(MongoConverterConfigurationAdapter)} to configure MongoDB

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

@@ -94,7 +94,6 @@ enum BulkMode {
 	 * Add a list of updates to the bulk operation. For each update request, all matching documents are updated.
 	 *
 	 * @param updates Update operations to perform.
-	 * @return The bulk operation.
 	 * @return the current {@link BulkOperations} instance with the update added, will never be {@literal null}.
 	 */
 	BulkOperations updateMulti(List<Pair<Query, Update>> updates);
@@ -105,7 +104,6 @@ enum BulkMode {
 	 *
 	 * @param query Update criteria.
 	 * @param update Update operation to perform.
-	 * @return The bulk operation.
 	 * @return the current {@link BulkOperations} instance with the update added, will never be {@literal null}.
 	 */
 	BulkOperations upsert(Query query, Update update);
@@ -115,7 +113,6 @@ enum BulkMode {
 	 * else an insert.
 	 *
 	 * @param updates Updates/insert operations to perform.
-	 * @return The bulk operation.
 	 * @return the current {@link BulkOperations} instance with the update added, will never be {@literal null}.
 	 */
 	BulkOperations upsert(List<Pair<Query, Update>> updates);

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

@@ -29,7 +29,7 @@
  * @author Grame Rocher
  * @author Oliver Gierke
  * @author John Brisbin
- * @auhtor Christoph Strobl
+ * @author Christoph Strobl
  * @since 1.0
  */
 public interface CollectionCallback<T> {

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

@@ -95,7 +95,7 @@ public static CollectionOptions empty() {
 
 	/**
 	 * Create new {@link CollectionOptions} with already given settings and capped set to {@literal true}. <br />
-	 * <strong>NOTE</strong> Using capped collections requires defining {@link #size(int)}.
+	 * <strong>NOTE</strong> Using capped collections requires defining {@link #size(long)}.
 	 *
 	 * @return new {@link CollectionOptions}.
 	 * @since 2.0

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

@@ -43,17 +43,18 @@ public interface CursorPreparer extends ReadPreferenceAware {
 	/**
 	 * Prepare the given cursor (apply limits, skips and so on). Returns the prepared cursor.
 	 *
-	 * @param cursor
+	 * @param iterable must not be {@literal null}.
+	 * @return never {@literal null}.
 	 */
-	FindIterable<Document> prepare(FindIterable<Document> cursor);
+	FindIterable<Document> prepare(FindIterable<Document> iterable);
 
 	/**
 	 * Apply query specific settings to {@link MongoCollection} and initate a find operation returning a
 	 * {@link FindIterable} via the given {@link Function find} function.
 	 *
 	 * @param collection must not be {@literal null}.
 	 * @param find must not be {@literal null}.
-	 * @return
+	 * @return never {@literal null}.
 	 * @throws IllegalArgumentException if one of the required arguments is {@literal null}.
 	 * @since 2.2
 	 */

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

@@ -23,7 +23,7 @@
 /**
  * An interface used by {@link MongoTemplate} for processing documents returned from a MongoDB query on a per-document
  * basis. Implementations of this interface perform the actual work of prcoessing each document but don't need to worry
- * about exception handling. {@MongoException}s will be caught and translated by the calling MongoTemplate An
+ * about exception handling. {@link MongoException}s will be caught and translated by the calling MongoTemplate An
  * DocumentCallbackHandler is typically stateful: It keeps the result state within the object, to be available later for
  * later inspection.
  *

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

@@ -66,7 +66,7 @@ class EntityOperations {
 	 * Creates a new {@link Entity} for the given bean.
 	 *
 	 * @param entity must not be {@literal null}.
-	 * @return
+	 * @return new instance of {@link Entity}.
 	 */
 	@SuppressWarnings({ "unchecked", "rawtypes" })
 	public <T> Entity<T> forEntity(T entity) {
@@ -89,7 +89,7 @@ public <T> Entity<T> forEntity(T entity) {
 	 *
 	 * @param entity must not be {@literal null}.
 	 * @param conversionService must not be {@literal null}.
-	 * @return
+	 * @return new instance of {@link AdaptibleEntity}.
 	 */
 	@SuppressWarnings({ "unchecked", "rawtypes" })
 	public <T> AdaptibleEntity<T> forEntity(T entity, ConversionService conversionService) {
@@ -108,6 +108,10 @@ public <T> AdaptibleEntity<T> forEntity(T entity, ConversionService conversionSe
 		return AdaptibleMappedEntity.of(entity, context, conversionService);
 	}
 
+	/**
+	 * @param entityClass should not be null.
+	 * @return the {@link MongoPersistentEntity#getCollection() collection name}.
+	 */
 	public String determineCollectionName(@Nullable Class<?> entityClass) {
 
 		if (entityClass == null) {
@@ -138,7 +142,7 @@ public Query getByIdInQuery(Collection<?> entities) {
 	 * {@code _id} if no identifier property can be found.
 	 *
 	 * @param type must not be {@literal null}.
-	 * @return
+	 * @return never {@literal null}.
 	 */
 	public String getIdPropertyName(Class<?> type) {
 

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

@@ -88,9 +88,9 @@ interface TerminatingAggregation<T> {
 
 		/**
 		 * 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}
+		 * Returns a {@link CloseableIterator} that wraps the a Mongo DB {@link com.mongodb.client.FindIterable}
 		 *
-		 * @return a {@link CloseableIterator} that wraps the a Mongo DB {@link com.mongodb.Cursor} that needs to be closed.
+		 * @return a {@link CloseableIterator} that wraps the a Mongo DB {@link com.mongodb.client.FindIterable} that needs to be closed.
 		 *         Never {@literal null}.
 		 */
 		CloseableIterator<T> stream();

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

@@ -118,7 +118,7 @@ default Optional<T> first() {
 		/**
 		 * Stream all matching elements.
 		 *
-		 * @return a {@link Stream} that wraps the a Mongo DB {@link com.mongodb.Cursor} that needs to be closed. Never
+		 * @return a {@link Stream} that wraps the a Mongo DB {@link com.mongodb.client.FindIterable} that needs to be closed. Never
 		 *         {@literal null}.
 		 */
 		Stream<T> stream();

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

@@ -257,9 +257,9 @@ static class DelegatingQueryCursorPreparer implements CursorPreparer {
 		 * @see org.springframework.data.mongodb.core.CursorPreparer#prepare(com.mongodb.clientFindIterable)
 		 */
 		@Override
-		public FindIterable<Document> prepare(FindIterable<Document> cursor) {
+		public FindIterable<Document> prepare(FindIterable<Document> iterable) {
 
-			FindIterable<Document> target = delegate != null ? delegate.prepare(cursor) : cursor;
+			FindIterable<Document> target = delegate != null ? delegate.prepare(iterable) : iterable;
 			return limit.map(target::limit).orElse(target);
 		}
 

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

@@ -78,7 +78,7 @@ public static FindAndModifyOptions none() {
 	}
 
 	/**
-	 * Create new {@link FindAndModifyOptions} based on option of given {@litearl source}.
+	 * Create new {@link FindAndModifyOptions} based on option of given {@literal source}.
 	 *
 	 * @param source can be {@literal null}.
 	 * @return new instance of {@link FindAndModifyOptions}.
@@ -117,8 +117,8 @@ public FindAndModifyOptions remove(boolean remove) {
 	/**
 	 * Define the {@link Collation} specifying language-specific rules for string comparison.
 	 *
-	 * @param collation
-	 * @return
+	 * @param collation can be {@literal null}.
+	 * @return this.
 	 * @since 2.0
 	 */
 	public FindAndModifyOptions collation(@Nullable Collation collation) {
@@ -142,7 +142,7 @@ public boolean isRemove() {
 	/**
 	 * Get the {@link Collation} specifying language-specific rules for string comparison.
 	 *
-	 * @return
+	 * @return never {@literal null}.
 	 * @since 2.0
 	 */
 	public Optional<Collation> getCollation() {

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

@@ -116,7 +116,7 @@ public FindAndReplaceOptions upsert() {
 	/**
 	 * Get the bit indicating to return the replacement document.
 	 *
-	 * @return
+	 * @return {@literal true} if set.
 	 */
 	public boolean isReturnNew() {
 		return returnNew;
@@ -125,7 +125,7 @@ public boolean isReturnNew() {
 	/**
 	 * Get the bit indicating if to create a new document if not exists.
 	 *
-	 * @return
+	 * @return {@literal true} if set.
 	 */
 	public boolean isUpsert() {
 		return upsert;

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

@@ -54,7 +54,7 @@ public interface FindPublisherPreparer extends ReadPreferenceAware {
 	 *
 	 * @param collection must not be {@literal null}.
 	 * @param find must not be {@literal null}.
-	 * @return
+	 * @return never {@literal null}.
 	 * @throws IllegalArgumentException if one of the required arguments is {@literal null}.
 	 * @since 2.2
 	 */

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

@@ -47,7 +47,7 @@ private GeoCommandStatistics(Document source) {
 	 * Creates a new {@link GeoCommandStatistics} from the given command result extracting the statistics.
 	 *
 	 * @param commandResult must not be {@literal null}.
-	 * @return
+	 * @return never {@literal null}.
 	 */
 	public static GeoCommandStatistics from(Document commandResult) {
 
@@ -61,7 +61,7 @@ public static GeoCommandStatistics from(Document commandResult) {
 	 * Returns the average distance reported by the command result. Mitigating a removal of the field in case the command
 	 * didn't return any result introduced in MongoDB 3.2 RC1.
 	 *
-	 * @return
+	 * @return never {@literal null}, uses {@link Double#NaN} if {@literal avgDistance} does not exist.
 	 * @see <a href="https://jira.mongodb.org/browse/SERVER-21024">MongoDB Jira SERVER-21024</a>
 	 */
 	public double getAverageDistance() {

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

@@ -79,7 +79,7 @@ public interface MongoOperations extends FluentMongoOperations {
 	 * The collection name used for the specified class by this template.
 	 *
 	 * @param entityClass must not be {@literal null}.
-	 * @return
+	 * @return never {@literal null}.
 	 */
 	String getCollectionName(Class<?> entityClass);
 
@@ -363,7 +363,7 @@ public <T> T execute(SessionCallback<T> action, Consumer<ClientSession> onComple
 	/**
 	 * Returns the {@link ScriptOperations} that can be performed on {@link com.mongodb.client.MongoDatabase} level.
 	 *
-	 * @return
+	 * @return never {@literal null}.
 	 * @since 1.7
 	 * @deprecated since 2.2. The {@code eval} command has been removed without replacement in MongoDB Server 4.2.0.
 	 */
@@ -1557,7 +1557,7 @@ <S, T> T findAndReplace(Query query, S replacement, FindAndReplaceOptions option
 	/**
 	 * Returns the underlying {@link MongoConverter}.
 	 *
-	 * @return
+	 * @return never {@literal null}.
 	 */
 	MongoConverter getConverter();
 }

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

@@ -3199,9 +3199,9 @@ public QueryCursorPreparer(Query query, @Nullable Class<?> type) {
 		 * (non-Javadoc)
 		 * @see org.springframework.data.mongodb.core.CursorPreparer#prepare(com.mongodb.DBCursor)
 		 */
-		public FindIterable<Document> prepare(FindIterable<Document> cursor) {
+		public FindIterable<Document> prepare(FindIterable<Document> iterable) {
 
-			FindIterable<Document> cursorToUse = cursor;
+			FindIterable<Document> cursorToUse = iterable;
 
 			operations.forType(type).getCollation(query) //
 					.map(Collation::toMongoCollation) //

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

@@ -1239,7 +1239,7 @@ <S, T> Mono<T> findAndReplace(Query query, S replacement, FindAndReplaceOptions
 	 * domain type information. Use {@link #updateFirst(Query, UpdateDefinition, Class, String)} to get full type specific
 	 * support. <br />
 	 * <strong>NOTE:</strong> {@link Query#getSortObject() sorting} is not supported by {@code db.collection.updateOne}.
-	 * Use {@link #findAndModify(Query, Update, Class, String)} instead.
+	 * Use {@link #findAndModify(Query, UpdateDefinition, Class, String)} instead.
 	 *
 	 * @param query the query document that specifies the criteria used to select a record to be updated. Must not be
 	 *          {@literal null}.
@@ -1572,15 +1572,15 @@ <T> Flux<T> mapReduce(Query filterQuery, Class<?> domainType, String inputCollec
 	/**
 	 * Returns the underlying {@link MongoConverter}.
 	 *
-	 * @return
+	 * @return never {@literal null}.
 	 */
 	MongoConverter getConverter();
 
 	/**
 	 * The collection name used for the specified class by this template.
 	 *
 	 * @param entityClass must not be {@literal null}.
-	 * @return
+	 * @return never {@literal null}.
 	 * @since 2.1
 	 */
 	String getCollectionName(Class<?> entityClass);