Flatten tree

Author: bitwiseman

src/main/java/org/kohsuke/github/GitHubEndpointIterable.java

@@ -107,8 +107,8 @@ static <P extends GitHubPage<I>, I> GitHubEndpointIterable<P, I> ofSingleton(P p
         return new GitHubEndpointIterable<>(null, null, (Class<P>) page.getClass(), itemType, null) {
             @Nonnull
             @Override
-            public GitHubPageIterator<P, I> pageIterator() {
-                return GitHubPageIterator.ofSingleton(page);
+            public GitHubEndpointPageIterator<P, I> pageIterator() {
+                return GitHubEndpointPageIterator.ofSingleton(page);
             }
         };
     }
@@ -165,7 +165,7 @@ public final Iterator<Item> iterator() {
      * @return
      */
     @Nonnull
-    public GitHubPageIterator<Page, Item> pageIterator() {
+    public GitHubEndpointPageIterator<Page, Item> pageIterator() {
         return new GitHubEndpointPageIterator<>(client, pageType, request, pageSize, itemInitializer);
     }
 
@@ -251,7 +251,7 @@ private Item[] concatenatePages(List<Item[]> pages, int totalLength) {
      * @throws IOException
      *             if an I/O exception occurs.
      */
-    private Item[] toArray(final GitHubPageIterator<Page, Item> iterator, Class<Item> itemType) throws IOException {
+    private Item[] toArray(final GitHubEndpointPageIterator<Page, Item> iterator, Class<Item> itemType) throws IOException {
         try {
             ArrayList<Item[]> pages = new ArrayList<>();
             int totalSize = 0;
@@ -284,7 +284,7 @@ private Item[] toArray(final GitHubPageIterator<Page, Item> iterator, Class<Item
      */
     @Nonnull
     final GitHubResponse<Item[]> toResponse() throws IOException {
-        GitHubPageIterator<Page, Item> iterator = pageIterator();
+        GitHubEndpointPageIterator<Page, Item> iterator = pageIterator();
         Item[] items = toArray(iterator, itemType);
         GitHubResponse<Page> lastResponse = iterator.finalResponse();
         return new GitHubResponse<>(lastResponse, items);

src/main/java/org/kohsuke/github/GitHubEndpointPageIterator.java

@@ -2,8 +2,10 @@
 
 import org.jetbrains.annotations.NotNull;
 
+import javax.annotation.Nonnull;
 import java.io.IOException;
 import java.net.URL;
+import java.util.NoSuchElementException;
 import java.util.function.Consumer;
 
 /**
@@ -21,8 +23,21 @@
  * @param <P>
  *            type of each page (not the items in the page).
  */
-class GitHubEndpointPageIterator<P extends GitHubPage<Item>, Item> extends GitHubPageIterator<P, Item> {
+class GitHubEndpointPageIterator<P extends GitHubPage<Item>, Item> implements java.util.Iterator<P> {
 
+    protected final Class<P> pageType;
+    private final Consumer<Item> itemInitializer;
+    /**
+     * The page that will be returned when {@link #next()} is called.
+     *
+     * <p>
+     * Will be {@code null} after {@link #next()} is called.
+     * </p>
+     * <p>
+     * Will not be {@code null} after {@link #fetchNext()} is called if a new page was fetched.
+     * </p>
+     */
+    private P next;
     /**
      * When done iterating over pages, it is on rare occasions useful to be able to get information from the final
      * response that was retrieved.
@@ -37,12 +52,18 @@ class GitHubEndpointPageIterator<P extends GitHubPage<Item>, Item> extends GitHu
      */
     protected GitHubRequest nextRequest;
 
+    private GitHubEndpointPageIterator(P page) {
+        this(null, (Class<P>)page.getClass(), null, 0, null);
+        this.next = page;
+    }
+
     GitHubEndpointPageIterator(GitHubClient client,
             Class<P> pageType,
             GitHubRequest request,
             int pageSize,
             Consumer<Item> itemInitializer) {
-        super(pageType, itemInitializer);
+        this.pageType = pageType;
+        this.itemInitializer = itemInitializer;
 
         if (pageSize > 0) {
             GitHubRequest.Builder<?> builder = request.toBuilder().with("per_page", pageSize);
@@ -57,6 +78,10 @@ class GitHubEndpointPageIterator<P extends GitHubPage<Item>, Item> extends GitHu
         this.nextRequest = request;
     }
 
+    static <P extends GitHubPage<Item>, Item> GitHubEndpointPageIterator<P, Item> ofSingleton(final P page) {
+        return new GitHubEndpointPageIterator<>(page);
+    }
+
     /**
      * On rare occasions the final response from iterating is needed.
      *
@@ -97,7 +122,8 @@ private void updateNextRequest(GitHubResponse<P> nextResponse) {
      * Fetch is called at the start of {@link #hasNext()} or {@link #next()} to fetch another page of data if it is
      * needed.
      * <p>
-     * If {@link #next} is not {@code null}, no further action is needed. If {@link #next} is {@code null} and
+     * If {@link #next} is not {@code null}, no further action is needed.
+     * If {@link #next} is {@code null} and
      * {@link #nextRequest} is {@code null}, there are no more pages to fetch.
      * </p>
      * <p>
@@ -106,10 +132,9 @@ private void updateNextRequest(GitHubResponse<P> nextResponse) {
      * after the current response, {@link #nextRequest} is set to {@code null}.
      * </p>
      */
-    @Override
     protected P fetchNext() {
-        if (next != null || nextRequest == null)
-            return null; // already fetched or no more data to fetch
+        if (nextRequest == null)
+            return null; // no more data to fetch
 
         P result;
 
@@ -132,4 +157,50 @@ protected P fetchNext() {
                 (connectorResponse) -> GitHubResponse.parseBody(connectorResponse, pageType));
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    public boolean hasNext() {
+        return peek() != null;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Nonnull
+    public P next() {
+        P result = peek();
+        if (result == null)
+            throw new NoSuchElementException();
+        next = null;
+        return result;
+    }
+
+    /**
+     *
+     * @return
+     */
+    public P peek() {
+        if (next == null) {
+            P result = fetchNext();
+            if (result != null) {
+                next = result;
+                initializeItems();
+            }
+        }
+        return next;
+    }
+
+    /**
+     * This method initializes items with local data after they are fetched. It is up to the implementer to decide what
+     * local data to apply.
+     *
+     */
+    private void initializeItems() {
+        if (itemInitializer != null) {
+            for (Item item : next.getItems()) {
+                itemInitializer.accept(item);
+            }
+        }
+    }
 }

src/main/java/org/kohsuke/github/GitHubPageItemIterator.java

@@ -25,9 +25,9 @@ class GitHubPageItemIterator<Page extends GitHubPage<Item>, Item> implements Ite
      */
     private int nextItemIndex;
 
-    private final GitHubPageIterator<Page, Item> pageIterator;
+    private final GitHubEndpointPageIterator<Page, Item> pageIterator;
 
-    GitHubPageItemIterator(GitHubPageIterator<Page, Item> pageIterator) {
+    GitHubPageItemIterator(GitHubEndpointPageIterator<Page, Item> pageIterator) {
         this.pageIterator = pageIterator;
     }
 
@@ -54,8 +54,24 @@ public Item next() {
      *
      * @return the list
      */
+    @Deprecated
     public List<Item> nextPage() {
-        return Arrays.asList(nextPageArray());
+        // if we have not fetched any pages yet, always fetch.
+        // If we have fetched at least one page, check hasNext()
+        if (currentPage == null) {
+            peek();
+        } else if (!hasNext()) {
+            throw new NoSuchElementException();
+        }
+
+        // Current should never be null after fetch
+        Objects.requireNonNull(currentPage);
+        Item[] r = currentPage.getItems();
+        if (nextItemIndex != 0) {
+            r = Arrays.copyOfRange(r, nextItemIndex, r.length);
+        }
+        nextItemIndex = currentPage.getItems().length;
+        return Arrays.asList(r);
     }
 
     /**
@@ -100,39 +116,4 @@ private Item lookupItem() {
                 ? currentPage.getItems()[nextItemIndex]
                 : null;
     }
-
-    /**
-     * Gets the next page worth of data.
-     *
-     * @return the list
-     */
-    protected Page currentPage() {
-        peek();
-        return currentPage;
-    }
-
-    /**
-     * Gets the next page worth of data.
-     *
-     * @return the list
-     */
-    @Nonnull
-    Item[] nextPageArray() {
-        // if we have not fetched any pages yet, always fetch.
-        // If we have fetched at least one page, check hasNext()
-        if (currentPage == null) {
-            peek();
-        } else if (!hasNext()) {
-            throw new NoSuchElementException();
-        }
-
-        // Current should never be null after fetch
-        Objects.requireNonNull(currentPage);
-        Item[] r = currentPage.getItems();
-        if (nextItemIndex != 0) {
-            r = Arrays.copyOfRange(r, nextItemIndex, r.length);
-        }
-        nextItemIndex = currentPage.getItems().length;
-        return r;
-    }
 }

src/main/java/org/kohsuke/github/GitHubPageIterator.java

@@ -33,7 +33,7 @@ <Result extends SearchResult<T>> PagedSearchIterable(GitHubEndpointIterable<Resu
      */
     public int getTotalCount() {
         // populate();
-        return paginatedEndpoint.itemIterator().currentPage().totalCount;
+        return paginatedEndpoint.pageIterator().peek().totalCount;
     }
 
     /**
@@ -43,6 +43,6 @@ public int getTotalCount() {
      */
     public boolean isIncomplete() {
         // populate();
-        return paginatedEndpoint.itemIterator().currentPage().incompleteResults;
+        return paginatedEndpoint.pageIterator().peek().incompleteResults;
     }
 }