Update Javadoc regarding sort order in RepositoryItemReader

Issue #4462
spring-projects · Apr 30, 2024 · 89db774 · 89db774
1 parent b020f41
commit 89db774
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/...nfrastructure/src/main/java/org/springframework/batch/item/data/RepositoryItemReader.java b/...nfrastructure/src/main/java/org/springframework/batch/item/data/RepositoryItemReader.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -117,7 +117,9 @@ public void setArguments(List<?> arguments) {
 	}
 
 	/**
-	 * Provides ordering of the results so that order is maintained between paged queries
+	 * Provides ordering of the results so that order is maintained between paged queries.
+	 * Use a {@link java.util.LinkedHashMap} in case of multiple sort entries to keep the
+	 * order.
 	 * @param sorts the fields to sort by and the directions
 	 */
 	public void setSort(Map<String, Sort.Direction> sorts) {

diff --git a/...rc/main/java/org/springframework/batch/item/data/builder/RepositoryItemReaderBuilder.java b/...rc/main/java/org/springframework/batch/item/data/builder/RepositoryItemReaderBuilder.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017-2023 the original author or authors.
+ * Copyright 2017-2024 the original author or authors.
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
@@ -130,6 +130,8 @@ public RepositoryItemReaderBuilder<T> arguments(Object... arguments) {
 
 	/**
 	 * Provides ordering of the results so that order is maintained between paged queries.
+	 * Use a {@link java.util.LinkedHashMap} in case of multiple sort entries to keep the
+	 * order.
 	 * @param sorts the fields to sort by and the directions.
 	 * @return The current instance of the builder.
 	 * @see RepositoryItemReader#setSort(Map)