DATAES-628 - documentation, assertions, ES7 adaption.

Author: sothawo

src/main/java/org/springframework/data/elasticsearch/Document.java

@@ -37,6 +37,7 @@
  * {@link UnsupportedOperationException} when calling modifying methods.
  *
  * @author Mark Paluch
+ * @author Peter-Josef Meisch
  * @since 4.0
  */
 public interface Document extends Map<String, Object> {
@@ -53,7 +54,7 @@ static Document create() {
 	/**
 	 * Create a {@link Document} from a {@link Map} containing key-value pairs and sub-documents.
 	 *
-	 * @param map source map containing key-value pairs and sub-documents.
+	 * @param map source map containing key-value pairs and sub-documents. must not be {@literal null}.
 	 * @return a new {@link Document}.
 	 */
 	static Document from(Map<String, Object> map) {
@@ -74,6 +75,9 @@ static Document from(Map<String, Object> map) {
 	 * @return the parsed {@link Document}.
 	 */
 	static Document parse(String json) {
+
+		Assert.notNull(json, "JSON must not be null");
+
 		try {
 			return new MapDocument(MapDocument.OBJECT_MAPPER.readerFor(Map.class).readValue(json));
 		} catch (IOException e) {
@@ -84,11 +88,14 @@ static Document parse(String json) {
 	/**
 	 * {@link #put(Object, Object)} the {@code key}/{@code value} tuple and return {@code this} {@link Document}.
 	 *
-	 * @param key key with which the specified value is to be associated.
+	 * @param key key with which the specified value is to be associated. must not be {@literal null}.
 	 * @param value value to be associated with the specified key.
 	 * @return {@code this} {@link Document}.
 	 */
 	default Document append(String key, Object value) {
+
+		Assert.notNull(key, "Key must not be null");
+
 		put(key, value);
 		return this;
 	}
@@ -369,12 +376,15 @@ default String getStringOrDefault(String key, Supplier<String> defaultValue) {
 	 * <p>
 	 * Any exception thrown by the function will be propagated to the caller.
 	 *
-	 * @param transformer functional interface to a apply
+	 * @param transformer functional interface to a apply. must not be {@literal null}.
 	 * @param <R> class of the result
 	 * @return the result of applying the function to this string
 	 * @see java.util.function.Function
 	 */
 	default <R> R transform(Function<? super Document, ? extends R> transformer) {
+
+		Assert.notNull(transformer, "transformer must not be null");
+
 		return transformer.apply(this);
 	}
 

src/main/java/org/springframework/data/elasticsearch/core/DocumentAdapters.java

@@ -44,8 +44,9 @@
 import com.fasterxml.jackson.core.JsonGenerator;
 
 /**
- * Utility class to adapt {@link org.elasticsearch.common.document.DocumentField} to
- * {@link org.springframework.data.elasticsearch.Document}.
+ * Utility class to adapt {@link org.elasticsearch.action.get.GetResponse},
+ * {@link org.elasticsearch.index.get.GetResult}, {@link org.elasticsearch.search.SearchHit},
+ * {@link org.elasticsearch.common.document.DocumentField} to {@link org.springframework.data.elasticsearch.Document}.
  *
  * @author Mark Paluch
  * @since 4.0

src/test/java/org/springframework/data/elasticsearch/core/DocumentAdaptersUnitTests.java

@@ -29,14 +29,14 @@
 import org.elasticsearch.index.get.GetResult;
 import org.elasticsearch.search.SearchHit;
 import org.junit.Test;
-
 import org.springframework.data.elasticsearch.Document;
 import org.springframework.data.elasticsearch.SearchDocument;
 
 /**
  * Unit tests for {@link DocumentAdapters}.
  *
  * @author Mark Paluch
+ * @author Peter-Josef Meisch
  */
 public class DocumentAdaptersUnitTests {
 
@@ -46,7 +46,7 @@ public void shouldAdaptGetResponse() {
 		Map<String, DocumentField> fields = Collections.singletonMap("field",
 				new DocumentField("field", Arrays.asList("value")));
 
-		GetResult getResult = new GetResult("index", "type", "my-id", 1, 0, 42, true, null, fields);
+		GetResult getResult = new GetResult("index", "type", "my-id", 1, 1, 42, true, null, fields, null);
 		GetResponse response = new GetResponse(getResult);
 
 		Document document = DocumentAdapters.from(response);
@@ -63,7 +63,7 @@ public void shouldAdaptGetResponseSource() {
 
 		BytesArray source = new BytesArray("{\"field\":\"value\"}");
 
-		GetResult getResult = new GetResult("index", "type", "my-id", 1, 0, 42, true, source, Collections.emptyMap());
+		GetResult getResult = new GetResult("index", "type", "my-id", 1, 1, 42, true, source, Collections.emptyMap(), null);
 		GetResponse response = new GetResponse(getResult);
 
 		Document document = DocumentAdapters.from(response);