OAK-11387: Extract ListUtils from CollectionUtils (#1983)

* OAK-11387: Extract ListUtils from CollectionUtils

* OAK-11387: Extract ListUtils from CollectionUtils - add class Javadoc

Author: reschke

oak-auth-external/src/test/java/org/apache/jackrabbit/oak/spi/security/authentication/external/impl/DynamicGroupsTest.java

@@ -23,7 +23,7 @@
 import org.apache.jackrabbit.api.security.user.User;
 import org.apache.jackrabbit.api.security.user.UserManager;
 import org.apache.jackrabbit.oak.api.Tree;
-import org.apache.jackrabbit.oak.commons.collections.CollectionUtils;
+import org.apache.jackrabbit.oak.commons.collections.ListUtils;
 import org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalGroup;
 import org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentity;
 import org.apache.jackrabbit.oak.spi.security.authentication.external.ExternalIdentityProvider;
@@ -292,7 +292,7 @@ public void testCrossIDPMembership() throws Exception {
         UserManager um = getUserManager(r);
         PrincipalManager pm = getPrincipalManager(r);
 
-        List<ExternalIdentityRef> declaredGroupRefs = CollectionUtils.toList(previouslySyncedUser.getDeclaredGroups());
+        List<ExternalIdentityRef> declaredGroupRefs = ListUtils.toList(previouslySyncedUser.getDeclaredGroups());
         assertTrue(declaredGroupRefs.size() > 1);
 
         String groupId = declaredGroupRefs.get(0).getId();

oak-auth-external/src/test/java/org/apache/jackrabbit/oak/spi/security/authentication/external/impl/principal/DynamicGroupValidatorTest.java

@@ -26,7 +26,7 @@
 import org.apache.jackrabbit.oak.api.Tree;
 import org.apache.jackrabbit.oak.api.Type;
 import org.apache.jackrabbit.oak.commons.PathUtils;
-import org.apache.jackrabbit.oak.commons.collections.CollectionUtils;
+import org.apache.jackrabbit.oak.commons.collections.ListUtils;
 import org.apache.jackrabbit.oak.plugins.memory.PropertyStates;
 import org.apache.jackrabbit.oak.plugins.tree.TreeUtil;
 import org.apache.jackrabbit.oak.spi.commit.CommitInfo;
@@ -268,7 +268,7 @@ public void testModifyMembersPropertyLocalGroup() throws Exception {
 
         Tree groupTree = r.getTree(localGroup.getPath());
         Tree userTree = r.getTree(userManager.getAuthorizable(USER_ID).getPath());
-        List<String> members = CollectionUtils.toList(groupTree.getProperty(REP_MEMBERS).getValue(Type.STRINGS));
+        List<String> members = ListUtils.toList(groupTree.getProperty(REP_MEMBERS).getValue(Type.STRINGS));
         members.add(userTree.getProperty(JCR_UUID).getValue(Type.STRING));
         groupTree.setProperty(REP_MEMBERS, members, Type.WEAKREFERENCES);
         r.commit();
@@ -300,7 +300,7 @@ public void testModifyMembersPropertyRemove() throws Exception {
         r.commit();
 
         Tree groupTree = r.getTree(localGroup.getPath());
-        List<String> members = CollectionUtils.toList(groupTree.getProperty(REP_MEMBERS).getValue(Type.STRINGS));
+        List<String> members = ListUtils.toList(groupTree.getProperty(REP_MEMBERS).getValue(Type.STRINGS));
         members.remove(1);
         groupTree.setProperty(REP_MEMBERS, members, Type.WEAKREFERENCES);
         r.commit();
@@ -318,7 +318,7 @@ public void testModifyMembersPropertyAdd() throws Exception {
 
         Tree groupTree = r.getTree(localGroup.getPath());
         Tree userTree = r.getTree(userManager.getAuthorizable(USER_ID).getPath());
-        List<String> members = CollectionUtils.toList(groupTree.getProperty(REP_MEMBERS).getValue(Type.STRINGS));
+        List<String> members = ListUtils.toList(groupTree.getProperty(REP_MEMBERS).getValue(Type.STRINGS));
         members.add(userTree.getProperty(JCR_UUID).getValue(Type.STRING));
         groupTree.setProperty(REP_MEMBERS, members, Type.WEAKREFERENCES);
         try {

oak-auth-external/src/test/java/org/apache/jackrabbit/oak/spi/security/authentication/external/impl/principal/ExternalGroupPrincipalProviderTest.java

@@ -28,6 +28,7 @@
 import org.apache.jackrabbit.oak.api.Tree;
 import org.apache.jackrabbit.oak.commons.PathUtils;
 import org.apache.jackrabbit.oak.commons.collections.CollectionUtils;
+import org.apache.jackrabbit.oak.commons.collections.ListUtils;
 import org.apache.jackrabbit.oak.commons.collections.StreamUtils;
 import org.apache.jackrabbit.oak.namepath.NamePathMapper;
 import org.apache.jackrabbit.oak.plugins.tree.TreeAware;
@@ -586,7 +587,7 @@ public Iterator<? extends Principal> findPrincipals(@Nullable String nameHint, i
                 return in.iterator();
             }
         };
-        List<Principal> out = CollectionUtils.toList(p.findPrincipals(null, false, PrincipalManager.SEARCH_TYPE_ALL, 0, -1));
+        List<Principal> out = ListUtils.toList(p.findPrincipals(null, false, PrincipalManager.SEARCH_TYPE_ALL, 0, -1));
         Collections.sort(in, Comparator.comparing(Principal::getName));
         assertEquals(in, out);
     }

oak-authorization-principalbased/src/test/java/org/apache/jackrabbit/oak/spi/security/authorization/principalbased/impl/PrincipalBasedAccessControlManagerTest.java

@@ -23,7 +23,7 @@
 import org.apache.jackrabbit.oak.api.Root;
 import org.apache.jackrabbit.oak.api.Tree;
 import org.apache.jackrabbit.oak.commons.PathUtils;
-import org.apache.jackrabbit.oak.commons.collections.CollectionUtils;
+import org.apache.jackrabbit.oak.commons.collections.ListUtils;
 import org.apache.jackrabbit.oak.plugins.tree.TreeUtil;
 import org.apache.jackrabbit.oak.spi.nodetype.NodeTypeConstants;
 import org.apache.jackrabbit.oak.spi.security.authorization.AuthorizationConfiguration;
@@ -554,7 +554,7 @@ public void testGetEffectivePrincipalsEmptyPaths() throws Exception {
         Iterator<AccessControlPolicy> effective = acMgr.getEffectivePolicies(principals, new String[0]);
         AccessControlPolicy[] expected = acMgr.getEffectivePolicies(principals);
 
-        assertArrayEquals(expected, (CollectionUtils.toList(effective).toArray()));
+        assertArrayEquals(expected, (ListUtils.toList(effective).toArray()));
     }
 
     @Test
@@ -567,7 +567,7 @@ public void testGetEffectivePrincipalsReadablePaths() throws Exception {
         String[] paths = readablePaths.stream().map(oakPath -> namePathMapper.getJcrPath(oakPath)).distinct().toArray(String[]::new);
         assertEquals(3, paths.length);
 
-        List<AccessControlPolicy> effective = CollectionUtils.toList(acMgr.getEffectivePolicies(Collections.singleton(validPrincipal), paths));
+        List<AccessControlPolicy> effective = ListUtils.toList(acMgr.getEffectivePolicies(Collections.singleton(validPrincipal), paths));
 
         assertEquals(1, effective.size());
         assertEquals(ReadPolicy.INSTANCE, effective.get(0));

oak-benchmarks-lucene/src/main/java/org/apache/jackrabbit/oak/benchmark/HybridIndexTest.java

@@ -48,7 +48,7 @@
 import org.apache.jackrabbit.oak.Oak;
 import org.apache.jackrabbit.oak.api.Type;
 import org.apache.jackrabbit.oak.api.jmx.IndexStatsMBean;
-import org.apache.jackrabbit.oak.commons.collections.CollectionUtils;
+import org.apache.jackrabbit.oak.commons.collections.ListUtils;
 import org.apache.jackrabbit.oak.fixture.JcrCreator;
 import org.apache.jackrabbit.oak.fixture.OakRepositoryFixture;
 import org.apache.jackrabbit.oak.fixture.RepositoryFixture;
@@ -512,7 +512,7 @@ public void initialize(@NotNull NodeBuilder builder) {
             if (nodetype.exists()) {
                 List<String> nodetypes = new ArrayList<>();
                 if (nodetype.hasProperty(DECLARING_NODE_TYPES)){
-                    nodetypes = CollectionUtils.toList(nodetype.getProperty(DECLARING_NODE_TYPES).getValue(Type.STRINGS));
+                    nodetypes = ListUtils.toList(nodetype.getProperty(DECLARING_NODE_TYPES).getValue(Type.STRINGS));
                 }
 
                 if (nodetypes.isEmpty()) {

oak-blob-cloud/src/main/java/org/apache/jackrabbit/oak/blob/cloud/s3/S3Backend.java

@@ -51,6 +51,7 @@
 import org.apache.jackrabbit.core.data.util.NamedThreadFactory;
 import org.apache.jackrabbit.oak.commons.PropertiesUtil;
 import org.apache.jackrabbit.oak.commons.collections.CollectionUtils;
+import org.apache.jackrabbit.oak.commons.collections.ListUtils;
 import org.apache.jackrabbit.oak.plugins.blob.datastore.directaccess.DataRecordDownloadOptions;
 import org.apache.jackrabbit.oak.plugins.blob.datastore.directaccess.DataRecordUpload;
 import org.apache.jackrabbit.oak.plugins.blob.datastore.directaccess.DataRecordUploadException;
@@ -1125,7 +1126,7 @@ private boolean loadBatch() {
                     return false;
                 }
 
-                List<S3ObjectSummary> listing = CollectionUtils.toList(
+                List<S3ObjectSummary> listing = ListUtils.toList(
                     filter(prevObjectListing.getObjectSummaries(),
                             input -> !input.getKey().startsWith(META_KEY_PREFIX)));
 

oak-blob-plugins/src/main/java/org/apache/jackrabbit/oak/plugins/blob/datastore/BlobIdTracker.java

@@ -37,7 +37,7 @@
 import org.apache.jackrabbit.guava.common.base.Stopwatch;
 import org.apache.jackrabbit.guava.common.io.Files;
 import org.apache.jackrabbit.core.data.DataRecord;
-import org.apache.jackrabbit.oak.commons.collections.CollectionUtils;
+import org.apache.jackrabbit.oak.commons.collections.ListUtils;
 import org.apache.jackrabbit.oak.commons.concurrent.ExecutorCloser;
 import org.apache.jackrabbit.oak.commons.io.BurnOnCloseFileIterator;
 import org.apache.jackrabbit.oak.commons.io.FileLineDifferenceIterator;
@@ -268,7 +268,7 @@ private void globalMerge() throws IOException {
             Iterable<DataRecord> refRecords = datastore.getAllMetadataRecords(fileNamePrefix);
 
             // Download all the corresponding files for the records
-            List<File> refFiles = CollectionUtils.toList(transform(refRecords, input -> {
+            List<File> refFiles = ListUtils.toList(transform(refRecords, input -> {
                     InputStream inputStream = null;
                     try {
                         inputStream = input.getStream();

oak-blob-plugins/src/test/java/org/apache/jackrabbit/oak/plugins/blob/datastore/ActiveDeletionTrackerStoreTest.java

@@ -32,6 +32,7 @@
 import org.apache.jackrabbit.guava.common.base.Strings;
 import org.apache.jackrabbit.oak.commons.FileIOUtils;
 import org.apache.jackrabbit.oak.commons.collections.CollectionUtils;
+import org.apache.jackrabbit.oak.commons.collections.ListUtils;
 import org.apache.jackrabbit.oak.plugins.blob.SharedDataStore;
 import org.apache.jackrabbit.oak.plugins.blob.datastore.BlobIdTracker.ActiveDeletionTracker;
 import org.junit.After;
@@ -117,7 +118,7 @@ public void filter() throws Exception {
         File toFilter = create(range(7, 10), folder);
         Iterator<String> filtered = tracker.filter(toFilter);
 
-        assertTrue("More elements after filtering", CollectionUtils.toList(filtered).isEmpty());
+        assertTrue("More elements after filtering", ListUtils.toList(filtered).isEmpty());
     }
 
     @Test
@@ -127,7 +128,7 @@ public void noFilter() throws Exception {
         File toFilterFile = create(toFilter, folder);
         Iterator<String> filtered = tracker.filter(toFilterFile);
 
-        assertEquals("Incorrect elements after filtering", range(0, 4), CollectionUtils.toList(filtered));
+        assertEquals("Incorrect elements after filtering", range(0, 4), ListUtils.toList(filtered));
     }
 
     @Test
@@ -138,7 +139,7 @@ public void filterWithExtraElements() throws Exception {
         Iterator<String> filtered = tracker.filter(toFilterFile);
 
         assertEquals("Incorrect elements after filtering",
-            range(0, 4), CollectionUtils.toList(filtered));
+            range(0, 4), ListUtils.toList(filtered));
     }
 
     @Test

oak-blob-plugins/src/test/java/org/apache/jackrabbit/oak/plugins/blob/datastore/DataStoreBlobStoreTest.java

@@ -37,6 +37,7 @@
 import org.apache.jackrabbit.core.data.DataStore;
 import org.apache.jackrabbit.core.data.DataStoreException;
 import org.apache.jackrabbit.oak.commons.collections.CollectionUtils;
+import org.apache.jackrabbit.oak.commons.collections.ListUtils;
 import org.apache.jackrabbit.oak.plugins.blob.BlobStoreBlob;
 import org.apache.jackrabbit.oak.spi.blob.AbstractBlobStoreTest;
 import org.apache.jackrabbit.oak.spi.blob.BlobStoreInputStream;
@@ -169,7 +170,7 @@ public void testGetAllChunks() throws Exception{
         DataIdentifier d20 = new DataIdentifier("d-20");
         DataIdentifier d30 = new DataIdentifier("d-30");
         List<DataIdentifier> dis = List.of(d10, d20, d30);
-        List<DataRecord> recs = CollectionUtils.toList(
+        List<DataRecord> recs = ListUtils.toList(
             Iterables.transform(dis, input -> new TimeDataRecord(input)));
         OakFileDataStore mockedDS = mock(OakFileDataStore.class);
         when(mockedDS.getAllRecords()).thenReturn(recs.iterator());

oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/collections/CollectionUtils.java

@@ -19,7 +19,6 @@
 package org.apache.jackrabbit.oak.commons.collections;
 
 import java.util.ArrayDeque;
-import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.HashMap;
@@ -28,8 +27,6 @@
 import java.util.Iterator;
 import java.util.LinkedHashMap;
 import java.util.LinkedHashSet;
-import java.util.LinkedList;
-import java.util.List;
 import java.util.Map;
 import java.util.Objects;
 import java.util.Properties;
@@ -38,7 +35,6 @@
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.function.Predicate;
 import java.util.stream.Collectors;
-import java.util.stream.IntStream;
 import java.util.stream.Stream;
 
 import org.jetbrains.annotations.NotNull;
@@ -56,79 +52,6 @@ private CollectionUtils() {
         // no instances for you
     }
 
-    /**
-     * Convert an iterable to a list. The returning list is mutable and supports all optional operations.
-     * @param iterable the iterable to convert
-     * @return the list
-     * @param <T> the type of the elements
-     */
-    @NotNull
-    public static <T> List<T> toList(@NotNull final Iterable<? extends T> iterable) {
-        Objects.requireNonNull(iterable);
-        List<T> result = new ArrayList<>();
-        iterable.forEach(result::add);
-        return result;
-    }
-
-    /**
-     * Convert an iterable to a {@link java.util.LinkedList}. The returning LinkedList is mutable and supports all optional operations.
-     * @param iterable the iterator to convert
-     * @return the LinkedList
-     * @param <T> the type of the elements
-     */
-    @NotNull
-    public static <T> List<T> toLinkedList(final Iterable<T> iterable) {
-        Objects.requireNonNull(iterable);
-        List<T> result = new LinkedList<>();
-        iterable.forEach(result::add);
-        return result;
-    }
-
-    /**
-     * Convert an iterator to a list. The returning list is mutable and supports all optional operations.
-     * @param iterator the iterator to convert
-     * @return the list
-     * @param <T> the type of the elements
-     */
-    @NotNull
-    public static <T> List<T> toList(final Iterator<? extends T> iterator) {
-        Objects.requireNonNull(iterator);
-        List<T> result = new ArrayList<>();
-        iterator.forEachRemaining(result::add);
-        return result;
-    }
-
-    /**
-     * Split a list into partitions of a given size.
-     *
-     * @param list the list to partition
-     * @param n the size of partitions
-     * @return a list of partitions. The resulting partitions aren’t a view of the main List, so any changes happening to the main List won’t affect the partitions.
-     * @param <T> the type of the elements
-     */
-    @NotNull
-    public static <T> List<List<T>> partitionList(final List<T> list, final int n) {
-        Objects.requireNonNull(list);
-        return IntStream.range(0, list.size())
-                .filter(i -> i % n == 0)
-                .mapToObj(i -> list.subList(i, Math.min(i + n, list.size())))
-                .collect(Collectors.toList());
-    }
-
-    /**
-     * Returns a new list containing the elements of the specified list in reverse order.
-     *
-     * @param <T> the type of elements in the list
-     * @param l the list to be reversed, must not be null
-     * @return a new list containing the elements of the specified list in reverse order
-     * @throws NullPointerException if the list is null
-     */
-    @NotNull
-    public static <T> List<T> reverse(final List<T> l) {
-        Objects.requireNonNull(l);
-        return IntStream.range(0, l.size()).map(i -> l.size() - 1- i).mapToObj(l::get).collect(Collectors.toList());
-    }
-
     /**
      * Convert an iterable to a set. The returning set is mutable and supports all optional operations.
      * @param iterable the iterable to convert