Skip to content

Commit 20e233e

Browse files
gargharsh3134Harsh Garg
and
Harsh Garg
authored
Fixing inline javadocs usage in PaginationStrategy (opensearch-project#16428)
Signed-off-by: Harsh Garg <gkharsh@amazon.com> Co-authored-by: Harsh Garg <gkharsh@amazon.com>
1 parent 1982427 commit 20e233e

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

server/src/main/java/org/opensearch/action/pagination/PaginationStrategy.java

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,11 @@ public interface PaginationStrategy<T> {
4444
List<T> getRequestedEntities();
4545

4646
/**
47-
*
48-
* Utility method to get list of indices filtered as per {@param filterPredicate} and the sorted according to {@param comparator}.
47+
* Utility method to get list of indices filtered and sorted as per the provided parameters.
48+
* @param clusterState state consisting of all the indices to be filtered and sorted.
49+
* @param filterPredicate predicate to be used for filtering out the required indices.
50+
* @param comparator comparator to be used for sorting the already filtered list of indices.
51+
* @return list of filtered and sorted IndexMetadata.
4952
*/
5053
static List<IndexMetadata> getSortedIndexMetadata(
5154
final ClusterState clusterState,
@@ -56,8 +59,10 @@ static List<IndexMetadata> getSortedIndexMetadata(
5659
}
5760

5861
/**
59-
*
60-
* Utility method to get list of indices sorted as per {@param comparator}.
62+
* Utility method to get list of sorted indices.
63+
* @param clusterState state consisting of indices to be sorted.
64+
* @param comparator comparator to be used for sorting the list of indices.
65+
* @return list of sorted IndexMetadata.
6166
*/
6267
static List<IndexMetadata> getSortedIndexMetadata(final ClusterState clusterState, Comparator<IndexMetadata> comparator) {
6368
return clusterState.metadata().indices().values().stream().sorted(comparator).collect(Collectors.toList());

0 commit comments

Comments
 (0)