From d237ee80c82868555c9bf50f5e5912007e78eefd Mon Sep 17 00:00:00 2001 From: Oliver Gierke Date: Fri, 12 Aug 2011 20:06:04 +0200 Subject: [PATCH] DATADOC-239 - Clarify documentation of passed in values for MongoReader. --- .../data/mongodb/core/MongoTemplate.java | 2 ++ .../data/mongodb/core/convert/MongoReader.java | 11 ++++------- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/MongoTemplate.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/MongoTemplate.java index 638cb8c72..7ae724a20 100644 --- a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/MongoTemplate.java +++ b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/MongoTemplate.java @@ -1252,6 +1252,8 @@ public class MongoTemplate implements MongoOperations, ApplicationContextAware { private final Class type; public ReadDbObjectCallback(MongoReader reader, Class type) { + Assert.notNull(reader); + Assert.notNull(type); this.reader = reader; this.type = type; } diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/convert/MongoReader.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/convert/MongoReader.java index 46c877137..1eb8fbdef 100644 --- a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/convert/MongoReader.java +++ b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/convert/MongoReader.java @@ -20,8 +20,7 @@ import com.mongodb.DBObject; /** * A MongoWriter is responsible for converting a native MongoDB DBObject to an object of type T. * - * @param - * the type of the object to convert from a DBObject + * @param the type of the object to convert from a DBObject * @author Mark Pollack * @author Thomas Risberg * @author Oliver Gierke @@ -33,11 +32,9 @@ public interface MongoReader { * starting point for marshalling the {@link DBObject} into it. So in case there's no real valid data inside * {@link DBObject} for the given type, just return an empty instance of the given type. * - * @param clazz - * the type of the return value - * @param dbo - * theDBObject - * @return the converted object + * @param clazz the type of the return value. Will never be {@literal null}. + * @param dbo the {@link DBObject} to convert into a domain object. Might be {@literal null}. + * @return the converted object. Might be {@literal null}. */ S read(Class clazz, DBObject dbo); }