Add convenient scan methods in AeroMapper to return a List of result. (#78)

Related GitHub issue: #77.

Author: roimenashe

src/main/java/com/aerospike/mapper/tools/AeroMapper.java

@@ -491,6 +491,22 @@ public <T> void scan(ScanPolicy policy, @NotNull Class<T> clazz, @NotNull Proces
         }
     }
 
+    @Override
+    public <T> List<T> scan(@NotNull Class<T> clazz) {
+        return scan(null, clazz);
+    }
+
+    @Override
+    public <T> List<T> scan(ScanPolicy policy, @NotNull Class<T> clazz) {
+        List<T> result = new ArrayList<>();
+        Processor<T> resultProcessor = record -> {
+            result.add(record);
+            return true;
+        };
+        scan(policy, clazz, resultProcessor);
+        return result;
+    }
+
     @Override
     public <T> void query(@NotNull Class<T> clazz, @NotNull Processor<T> processor, Filter filter) {
         query(null, clazz, processor, filter);

src/main/java/com/aerospike/mapper/tools/IAeroMapper.java

@@ -251,6 +251,23 @@ public interface IAeroMapper extends IBaseAeroMapper {
      */
     <T> void scan(ScanPolicy policy, @NotNull Class<T> clazz, @NotNull Processor<T> processor, int recordsPerSecond);
 
+    /**
+     * Scan every record in the set associated with the passed class
+     * and returns the list of records converted to the appropriate class.
+     *
+     * @param clazz - the class used to determine which set to scan and to convert the returned records to.
+     */
+    <T> List<T> scan(@NotNull Class<T> clazz);
+
+    /**
+     * Scan every record in the set associated with the passed class using a provided ScanPolicy
+     * and returns the list of records converted to the appropriate class.
+     *
+     * @param policy - the scan policy to use. If this is null, the default scan policy of the passed class will be used.
+     * @param clazz  - the class used to determine which set to scan and to convert the returned records to.
+     */
+    <T> List<T> scan(ScanPolicy policy, @NotNull Class<T> clazz);
+
     /**
      * Perform a secondary index query with the specified query policy. Each record will be converted
      * to the appropriate class then passed to the processor. If the processor returns false the query is aborted

src/test/java/com/aerospike/mapper/QueryTest.java

@@ -71,7 +71,7 @@ public int hashCode() {
         }
     }
 
-    private List<A> data = new ArrayList<A>() {{
+    private final List<A> data = new ArrayList<A>() {{
         add(new A(1, "Tim", 312));
         add(new A(2, "Bob", 44));
         add(new A(3, "Sue", 56));

src/test/java/com/aerospike/mapper/ScanTest.java

@@ -1,7 +1,12 @@
 package com.aerospike.mapper;
 
+import static java.util.Comparator.comparing;
+import static java.util.stream.Collectors.toList;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Objects;
 import java.util.concurrent.atomic.AtomicInteger;
 
 import org.junit.jupiter.api.Test;
@@ -39,17 +44,43 @@ public String getName() {
         public int getAge() {
             return age;
         }
+
+        @Override
+        public String toString() {
+            return String.format("id:%d, name:%s, age:%d", id, name, age);
+        }
+
+        @Override
+        public boolean equals(Object o) {
+            if (this == o) {
+                return true;
+            }
+            if (o == null || getClass() != o.getClass()) {
+                return false;
+            }
+            Person person = (Person) o;
+            return id == person.id && age == person.age && Objects.equals(name, person.name);
+        }
+
+        @Override
+        public int hashCode() {
+            return Objects.hash(id, name, age);
+        }
     }
 
+    private final List<Person> data = new ArrayList<Person>() {{
+        add(new Person(1, "Tim", 312));
+        add(new Person(2, "Bob", 44));
+        add(new Person(3, "Sue", 56));
+        add(new Person(4, "Rob", 23));
+        add(new Person(5, "Jim", 32));
+        add(new Person(6, "Bob", 78));
+    }};
+
     private AeroMapper populate() {
         client.truncate(null, "test", "testScan", null);
         AeroMapper mapper = new AeroMapper.Builder(client).build();
-        mapper.save(new Person(1, "Tim", 312),
-                new Person(2, "Bob", 44),
-                new Person(3, "Sue", 56),
-                new Person(4, "Rob", 23),
-                new Person(5, "Jim", 32),
-                new Person(6, "Bob", 78));
+        mapper.save(data.toArray());
         return mapper;
     }
 
@@ -89,4 +120,33 @@ public void scanTestWithAbort() {
         });
         assertEquals(1, counter.get());
     }
+
+    @Test
+    public void scanTestReturnsList() {
+        AeroMapper mapper = populate();
+
+        List<Person> result = mapper.scan(Person.class);
+
+        List<Person> expected = data.stream()
+                .sorted(comparing(Person::getId))
+                .collect(toList());
+        assertEquals(6, result.size());
+        assertEquals(expected, result.stream().sorted(comparing(Person::getId)).collect(toList()));
+    }
+
+    @Test
+    public void scanWithScanPolicyTestReturnsList() {
+        AeroMapper mapper = populate();
+        ScanPolicy scanPolicy = new ScanPolicy();
+        scanPolicy.filterExp = Exp.build(Exp.eq(Exp.stringBin("name"), Exp.val("Bob")));
+
+        List<Person> result = mapper.scan(scanPolicy, Person.class);
+
+        List<Person> expected = data.stream()
+                .filter(d -> d.name.equals("Bob"))
+                .sorted(comparing(Person::getId))
+                .collect(toList());
+        assertEquals(2, result.size());
+        assertEquals(expected, result.stream().sorted(comparing(Person::getId)).collect(toList()));
+    }
 }