DATAES-579 - Polishing.

Use Lombok's Data where possible. Extract duplicate code into ResourceUtil and StreamQueries. Generalize multiGet to return List instead of LinkedList. Reorder methods.

Reduce properties usage by removing unused properties from test entities.

Remove final keyword usage in methods. Formatting.

Original pull request: #283.

Author: mp911de

Diff for: src/main/java/org/springframework/data/elasticsearch/annotations/Document.java

@@ -15,41 +15,81 @@
  */
 package org.springframework.data.elasticsearch.annotations;
 
-import java.lang.annotation.*;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Inherited;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
 
 import org.elasticsearch.index.VersionType;
+
 import org.springframework.data.annotation.Persistent;
 
 /**
- * Document
+ * Identifies a domain object to be persisted to Elasticsearch.
  *
  * @author Rizwan Idrees
  * @author Mohsin Husen
  * @author Mason Chan
  * @author Ivan Greene
+ * @author Mark Paluch
  */
-
 @Persistent
 @Inherited
 @Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.TYPE})
+@Target({ ElementType.TYPE })
 public @interface Document {
 
+	/**
+	 * Name of the Elasticsearch index.
+	 * <ul>
+	 * <li>Lowercase only</li>
+	 * <li><Cannot include \, /, *, ?, ", <, >, |, ` ` (space character), ,, #/li>
+	 * <li>Cannot start with -, _, +</li>
+	 * <li>Cannot be . or ..</li>
+	 * <li>Cannot be longer than 255 bytes (note it is bytes, so multi-byte characters will count towards the 255 limit
+	 * faster)</li>
+	 * </ul>
+	 */
 	String indexName();
 
+	/**
+	 * Mapping type name.
+	 */
 	String type() default "";
 
+	/**
+	 * Use server-side settings when creating the index.
+	 */
 	boolean useServerConfiguration() default false;
 
+	/**
+	 * Number of shards for the index {@link #indexName()}. Used for index creation.
+	 */
 	short shards() default 5;
 
+	/**
+	 * Number of replicas for the index {@link #indexName()}. Used for index creation.
+	 */
 	short replicas() default 1;
 
+	/**
+	 * Refresh interval for the index {@link #indexName()}. Used for index creation.
+	 */
 	String refreshInterval() default "1s";
 
+	/**
+	 * Index storage type for the index {@link #indexName()}. Used for index creation.
+	 */
 	String indexStoreType() default "fs";
 
+	/**
+	 * Configuration whether to create an index on repository bootstrapping.
+	 */
 	boolean createIndex() default true;
 
+	/**
+	 * Configuration of version management.
+	 */
 	VersionType versionType() default VersionType.EXTERNAL;
 }

Diff for: src/main/java/org/springframework/data/elasticsearch/core/DefaultResultMapper.java

@@ -20,7 +20,6 @@
 import java.nio.charset.Charset;
 import java.util.ArrayList;
 import java.util.Collection;
-import java.util.LinkedList;
 import java.util.List;
 
 import org.elasticsearch.action.get.GetResponse;
@@ -29,6 +28,7 @@
 import org.elasticsearch.action.search.SearchResponse;
 import org.elasticsearch.common.document.DocumentField;
 import org.elasticsearch.search.SearchHit;
+
 import org.springframework.core.convert.ConversionService;
 import org.springframework.core.convert.support.DefaultConversionService;
 import org.springframework.data.domain.Pageable;
@@ -189,8 +189,8 @@ public <T> T mapResult(GetResponse response, Class<T> clazz) {
 	}
 
 	@Override
-	public <T> LinkedList<T> mapResults(MultiGetResponse responses, Class<T> clazz) {
-		LinkedList<T> list = new LinkedList<>();
+	public <T> List<T> mapResults(MultiGetResponse responses, Class<T> clazz) {
+		List<T> list = new ArrayList<>();
 		for (MultiGetItemResponse response : responses.getResponses()) {
 			if (!response.isFailed() && response.getResponse().isExists()) {
 				T result = mapEntity(response.getResponse().getSourceAsString(), clazz);

Diff for: src/main/java/org/springframework/data/elasticsearch/core/ElasticsearchOperations.java

@@ -15,20 +15,28 @@
  */
 package org.springframework.data.elasticsearch.core;
 
+import java.util.List;
+import java.util.Map;
+import java.util.stream.Collectors;
+
 import org.elasticsearch.action.update.UpdateResponse;
 import org.elasticsearch.cluster.metadata.AliasMetaData;
 import org.elasticsearch.common.Nullable;
+
 import org.springframework.data.domain.Page;
 import org.springframework.data.elasticsearch.core.convert.ElasticsearchConverter;
 import org.springframework.data.elasticsearch.core.mapping.ElasticsearchPersistentEntity;
-import org.springframework.data.elasticsearch.core.query.*;
+import org.springframework.data.elasticsearch.core.query.AliasQuery;
+import org.springframework.data.elasticsearch.core.query.CriteriaQuery;
+import org.springframework.data.elasticsearch.core.query.DeleteQuery;
+import org.springframework.data.elasticsearch.core.query.GetQuery;
+import org.springframework.data.elasticsearch.core.query.IndexQuery;
+import org.springframework.data.elasticsearch.core.query.MoreLikeThisQuery;
+import org.springframework.data.elasticsearch.core.query.SearchQuery;
+import org.springframework.data.elasticsearch.core.query.StringQuery;
+import org.springframework.data.elasticsearch.core.query.UpdateQuery;
 import org.springframework.data.util.CloseableIterator;
 
-import java.util.LinkedList;
-import java.util.List;
-import java.util.Map;
-import java.util.stream.Collectors;
-
 /**
  * ElasticsearchOperations
  *
@@ -42,9 +50,20 @@
 public interface ElasticsearchOperations {
 
 	/**
-	 * @return Converter in use
+	 * adding new alias
+	 *
+	 * @param query
+	 * @return
 	 */
-	ElasticsearchConverter getElasticsearchConverter();
+	boolean addAlias(AliasQuery query);
+
+	/**
+	 * removing previously created alias
+	 *
+	 * @param query
+	 * @return
+	 */
+	boolean removeAlias(AliasQuery query);
 
 	/**
 	 * Create an index for a class
@@ -102,7 +121,6 @@ public interface ElasticsearchOperations {
 	 */
 	<T> boolean putMapping(Class<T> clazz, Object mappings);
 
-
 	/**
 	 * Get mapping for a class
 	 *
@@ -133,6 +151,15 @@ public interface ElasticsearchOperations {
 	 */
 	<T> Map<String, Object> getSetting(Class<T> clazz);
 
+	/**
+	 * get all the alias pointing to specified index
+	 *
+	 * @param indexName
+	 * @return
+	 */
+	List<AliasMetaData> queryForAlias(String indexName);
+
+	<T> T query(SearchQuery query, ResultsExtractor<T> resultsExtractor);
 
 	/**
 	 * Execute the query against elasticsearch and return the first returned object
@@ -199,7 +226,8 @@ public interface ElasticsearchOperations {
 	<T> List<Page<T>> queryForPage(List<SearchQuery> queries, Class<T> clazz);
 
 	/**
-	 * Execute the multi-search against elasticsearch and return result as {@link List} of {@link Page} using custom mapper
+	 * Execute the multi-search against elasticsearch and return result as {@link List} of {@link Page} using custom
+	 * mapper
 	 *
 	 * @param queries
 	 * @param clazz
@@ -217,7 +245,8 @@ public interface ElasticsearchOperations {
 	List<Page<?>> queryForPage(List<SearchQuery> queries, List<Class<?>> classes);
 
 	/**
-	 * Execute the multi-search against elasticsearch and return result as {@link List} of {@link Page} using custom mapper
+	 * Execute the multi-search against elasticsearch and return result as {@link List} of {@link Page} using custom
+	 * mapper
 	 *
 	 * @param queries
 	 * @param classes
@@ -255,7 +284,8 @@ public interface ElasticsearchOperations {
 	/**
 	 * Executes the given {@link CriteriaQuery} against elasticsearch and return result as {@link CloseableIterator}.
 	 * <p>
-	 * Returns a {@link CloseableIterator} that wraps an Elasticsearch scroll context that needs to be closed in case of error.
+	 * Returns a {@link CloseableIterator} that wraps an Elasticsearch scroll context that needs to be closed in case of
+	 * error.
 	 *
 	 * @param <T> element return type
 	 * @param query
@@ -268,7 +298,8 @@ public interface ElasticsearchOperations {
 	/**
 	 * Executes the given {@link SearchQuery} against elasticsearch and return result as {@link CloseableIterator}.
 	 * <p>
-	 * Returns a {@link CloseableIterator} that wraps an Elasticsearch scroll context that needs to be closed in case of error.
+	 * Returns a {@link CloseableIterator} that wraps an Elasticsearch scroll context that needs to be closed in case of
+	 * error.
 	 *
 	 * @param <T> element return type
 	 * @param query
@@ -279,9 +310,11 @@ public interface ElasticsearchOperations {
 	<T> CloseableIterator<T> stream(SearchQuery query, Class<T> clazz);
 
 	/**
-	 * Executes the given {@link SearchQuery} against elasticsearch and return result as {@link CloseableIterator} using custom mapper.
+	 * Executes the given {@link SearchQuery} against elasticsearch and return result as {@link CloseableIterator} using
+	 * custom mapper.
 	 * <p>
-	 * Returns a {@link CloseableIterator} that wraps an Elasticsearch scroll context that needs to be closed in case of error.
+	 * Returns a {@link CloseableIterator} that wraps an Elasticsearch scroll context that needs to be closed in case of
+	 * error.
 	 *
 	 * @param <T> element return type
 	 * @param query
@@ -394,7 +427,7 @@ default List<List<?>> queryForList(List<SearchQuery> queries, List<Class<?>> cla
 	 * @param clazz
 	 * @return
 	 */
-	<T> LinkedList<T> multiGet(SearchQuery searchQuery, Class<T> clazz);
+	<T> List<T> multiGet(SearchQuery searchQuery, Class<T> clazz);
 
 	/**
 	 * Execute a multiGet against elasticsearch for the given ids with MultiGetResultMapper
@@ -404,7 +437,7 @@ default List<List<?>> queryForList(List<SearchQuery> queries, List<Class<?>> cla
 	 * @param multiGetResultMapper
 	 * @return
 	 */
-	<T> LinkedList<T> multiGet(SearchQuery searchQuery, Class<T> clazz, MultiGetResultMapper multiGetResultMapper);
+	<T> List<T> multiGet(SearchQuery searchQuery, Class<T> clazz, MultiGetResultMapper multiGetResultMapper);
 
 	/**
 	 * Index an object. Will do save or update
@@ -446,14 +479,14 @@ default List<List<?>> queryForList(List<SearchQuery> queries, List<Class<?>> cla
 	 */
 	String delete(String indexName, String type, String id);
 
-
 	/**
 	 * Delete all records matching the criteria
 	 *
 	 * @param clazz
 	 * @param criteriaQuery
 	 */
 	<T> void delete(CriteriaQuery criteriaQuery, Class<T> clazz);
+
 	/**
 	 * Delete the one object with provided id
 	 *
@@ -525,15 +558,13 @@ default List<List<?>> queryForList(List<SearchQuery> queries, List<Class<?>> cla
 	 * refresh the index
 	 *
 	 * @param indexName
-	 *
 	 */
 	void refresh(String indexName);
 
 	/**
 	 * refresh the index
 	 *
 	 * @param clazz
-	 *
 	 */
 	<T> void refresh(Class<T> clazz);
 
@@ -542,7 +573,7 @@ default List<List<?>> queryForList(List<SearchQuery> queries, List<Class<?>> cla
 	 *
 	 * @param query The search query.
 	 * @param scrollTimeInMillis The time in millisecond for scroll feature
-	 * {@link org.elasticsearch.action.search.SearchRequestBuilder#setScroll(org.elasticsearch.common.unit.TimeValue)}.
+	 *          {@link org.elasticsearch.action.search.SearchRequestBuilder#setScroll(org.elasticsearch.common.unit.TimeValue)}.
 	 * @param clazz The class of entity to retrieve.
 	 * @return The scan id for input query.
 	 */
@@ -553,18 +584,19 @@ default List<List<?>> queryForList(List<SearchQuery> queries, List<Class<?>> cla
 	 *
 	 * @param query The search query.
 	 * @param scrollTimeInMillis The time in millisecond for scroll feature
-	 * {@link org.elasticsearch.action.search.SearchRequestBuilder#setScroll(org.elasticsearch.common.unit.TimeValue)}.
+	 *          {@link org.elasticsearch.action.search.SearchRequestBuilder#setScroll(org.elasticsearch.common.unit.TimeValue)}.
 	 * @param mapper Custom impl to map result to entities
 	 * @return The scan id for input query.
 	 */
-	<T> ScrolledPage<T> startScroll(long scrollTimeInMillis, SearchQuery query, Class<T> clazz, SearchResultMapper mapper);
+	<T> ScrolledPage<T> startScroll(long scrollTimeInMillis, SearchQuery query, Class<T> clazz,
+			SearchResultMapper mapper);
 
 	/**
 	 * Returns scrolled page for given query
 	 *
 	 * @param criteriaQuery The search query.
 	 * @param scrollTimeInMillis The time in millisecond for scroll feature
-	 * {@link org.elasticsearch.action.search.SearchRequestBuilder#setScroll(org.elasticsearch.common.unit.TimeValue)}.
+	 *          {@link org.elasticsearch.action.search.SearchRequestBuilder#setScroll(org.elasticsearch.common.unit.TimeValue)}.
 	 * @param clazz The class of entity to retrieve.
 	 * @return The scan id for input query.
 	 */
@@ -575,20 +607,22 @@ default List<List<?>> queryForList(List<SearchQuery> queries, List<Class<?>> cla
 	 *
 	 * @param criteriaQuery The search query.
 	 * @param scrollTimeInMillis The time in millisecond for scroll feature
-	 * {@link org.elasticsearch.action.search.SearchRequestBuilder#setScroll(org.elasticsearch.common.unit.TimeValue)}.
+	 *          {@link org.elasticsearch.action.search.SearchRequestBuilder#setScroll(org.elasticsearch.common.unit.TimeValue)}.
 	 * @param mapper Custom impl to map result to entities
 	 * @return The scan id for input query.
 	 */
-	<T> ScrolledPage<T> startScroll(long scrollTimeInMillis, CriteriaQuery criteriaQuery, Class<T> clazz, SearchResultMapper mapper);
-
+	<T> ScrolledPage<T> startScroll(long scrollTimeInMillis, CriteriaQuery criteriaQuery, Class<T> clazz,
+			SearchResultMapper mapper);
 
 	<T> ScrolledPage<T> continueScroll(@Nullable String scrollId, long scrollTimeInMillis, Class<T> clazz);
-	<T> ScrolledPage<T> continueScroll(@Nullable String scrollId, long scrollTimeInMillis, Class<T> clazz, SearchResultMapper mapper);
+
+	<T> ScrolledPage<T> continueScroll(@Nullable String scrollId, long scrollTimeInMillis, Class<T> clazz,
+			SearchResultMapper mapper);
+
 	/**
 	 * Clears the search contexts associated with specified scroll ids.
 	 *
 	 * @param scrollId
-	 *
 	 */
 	<T> void clearScroll(String scrollId);
 
@@ -602,33 +636,10 @@ default List<List<?>> queryForList(List<SearchQuery> queries, List<Class<?>> cla
 	 */
 	<T> Page<T> moreLikeThis(MoreLikeThisQuery query, Class<T> clazz);
 
-	/**
-	 * adding new alias
-	 *
-	 * @param query
-	 * @return
-	 */
-	Boolean addAlias(AliasQuery query);
-
-	/**
-	 * removing previously created alias
-	 *
-	 * @param query
-	 * @return
-	 */
-	Boolean removeAlias(AliasQuery query);
+	ElasticsearchPersistentEntity getPersistentEntityFor(Class clazz);
 
 	/**
-	 * get all the alias pointing to specified index
-	 *
-	 * @param indexName
-	 * @return
+	 * @return Converter in use
 	 */
-	List<AliasMetaData> queryForAlias(String indexName);
-
-
-	<T> T query(SearchQuery query, ResultsExtractor<T> resultsExtractor);
-
-
-	ElasticsearchPersistentEntity getPersistentEntityFor(Class clazz);
+	ElasticsearchConverter getElasticsearchConverter();
 }