[JENKINS-76426] add lazy iteration APIs

Author: res0nance

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/BitbucketSCMSource.java

@@ -407,7 +407,7 @@ class Skip extends IOException {
         final Set<String> livePRs = new HashSet<>();
         int count = 0;
         Map<Boolean, Set<ChangeRequestCheckoutStrategy>> strategies = request.getPRStrategies();
-        for (final BitbucketPullRequest pull : request.getPullRequests()) {
+        for (final BitbucketPullRequest pull : request.getPullRequestsLazy()) {
             String originalBranchName = pull.getSource().getBranch().getName();
             request.listener().getLogger().printf(
                     "Checking PR-%s from %s and %s %s%n",
@@ -511,7 +511,7 @@ private void retrieveBranches(final BitbucketSCMSourceRequest request) throws IO
         request.listener().getLogger().println("Looking up " + fullName + " for branches");
 
         int count = 0;
-        for (final BitbucketBranch branch : request.getBranches()) {
+        for (final BitbucketBranch branch : request.getBranchesLazy()) {
             request.listener().getLogger().println("Checking branch " + branch.getName() + " from " + fullName);
             count++;
             BranchSCMHead head = new BranchSCMHead(branch.getName());
@@ -529,7 +529,7 @@ private void retrieveTags(final BitbucketSCMSourceRequest request) throws IOExce
         request.listener().getLogger().println("Looking up " + fullName + " for tags");
 
         int count = 0;
-        for (final BitbucketBranch tag : request.getTags()) {
+        for (final BitbucketBranch tag : request.getTagsLazy()) {
             request.listener().getLogger().println("Checking tag " + tag.getName() + " from " + fullName);
             count++;
             BitbucketTagSCMHead head = new BitbucketTagSCMHead(tag.getName(), tag.getDateMillis());

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/BitbucketSCMSourceRequest.java

@@ -511,6 +511,11 @@ public final Iterable<BitbucketPullRequest> getPullRequests() throws IOException
         return Util.fixNull(pullRequests);
     }
 
+    @NonNull
+    public final Iterable<BitbucketPullRequest> getPullRequestsLazy() {
+        return (Iterable<BitbucketPullRequest>) getBitbucketApiClient().getPullRequestsLazy();
+    }
+
     /**
      * Retrieves the full details of a pull request.
      * @param id The id of the pull request to retrieve the details about.
@@ -559,6 +564,11 @@ public final Iterable<BitbucketBranch> getBranches() throws IOException, Interru
         return Util.fixNull(branches);
     }
 
+    @NonNull
+    public final Iterable<BitbucketBranch> getBranchesLazy() {
+        return (Iterable<BitbucketBranch>) getBitbucketApiClient().getBranchesLazy();
+    }
+
     /**
      * Provides the requests with the tag details.
      *
@@ -585,6 +595,12 @@ public final Iterable<BitbucketBranch> getTags() throws IOException, Interrupted
         return Util.fixNull(tags);
     }
 
+    @NonNull
+    public final Iterable<BitbucketBranch> getTagsLazy() {
+        return (Iterable<BitbucketBranch>) getBitbucketApiClient().getTagsLazy();
+    }
+
+
     /**
      * {@inheritDoc}
      */

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/api/BitbucketApi.java

@@ -81,6 +81,14 @@ public interface BitbucketApi extends AutoCloseable {
     @NonNull
     BitbucketPullRequest getPullRequestById(@NonNull Integer id) throws IOException;
 
+    /**
+     * Returns the pull requests in the repository lazily
+     *
+     * @return the list of pull requests in the repository.
+     */
+    @NonNull
+    Iterable<? extends BitbucketPullRequest> getPullRequestsLazy();
+
     /**
      * Returns the repository details.
      *
@@ -139,6 +147,14 @@ boolean checkPathExists(@NonNull String branchOrHash, @NonNull String path)
     @NonNull
     List<? extends BitbucketBranch> getBranches() throws IOException, InterruptedException;
 
+    /**
+     * Returns the branches in the repository lazily.
+     *
+     * @return an interable of branches in the repository.
+     */
+    @NonNull
+    Iterable<? extends BitbucketBranch> getBranchesLazy();
+
     /**
      * Returns a tag in the repository.
      *
@@ -158,6 +174,16 @@ boolean checkPathExists(@NonNull String branchOrHash, @NonNull String path)
     @NonNull
     List<? extends BitbucketBranch> getTags() throws IOException, InterruptedException;
 
+    /**
+     * Returns the tags in the repository lazily
+     *
+     * @return an iterable of tags in the repository.
+     * @throws IOException if there was a network communications error.
+     * @throws InterruptedException if interrupted while waiting on remote communications.
+     */
+    @NonNull
+    Iterable<? extends BitbucketBranch> getTagsLazy();
+
     /**
      * Resolve the commit object given its hash.
      *

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/api/paginated/PageFetcher.java

@@ -0,0 +1,28 @@
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2026, CloudBees, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package com.cloudbees.jenkins.plugins.bitbucket.api.paginated;
+
+public interface PageFetcher<T> {
+    PaginatedList<T> fetchNextPage();
+}

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/api/paginated/PaginatedIterable.java

@@ -0,0 +1,41 @@
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2026, CloudBees, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package com.cloudbees.jenkins.plugins.bitbucket.api.paginated;
+
+import java.util.Iterator;
+import java.util.function.Supplier;
+
+public class PaginatedIterable<T> implements Iterable<T> {
+
+    private final Supplier<PageFetcher<T>> fetcherSupplier;
+
+    public PaginatedIterable(Supplier<PageFetcher<T>> fetcherSupplier) {
+        this.fetcherSupplier = fetcherSupplier;
+    }
+
+    @Override
+    public Iterator<T> iterator() {
+        return new PaginatedIterator<>(fetcherSupplier.get());
+    }
+}

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/api/paginated/PaginatedIterator.java

@@ -0,0 +1,73 @@
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2026, CloudBees, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package com.cloudbees.jenkins.plugins.bitbucket.api.paginated;
+
+import java.util.Iterator;
+import java.util.NoSuchElementException;
+
+public class PaginatedIterator<T> implements Iterator<T> {
+
+    private final PageFetcher<T> fetcher;
+    private Iterator<T> currentIterator;
+    private boolean lastPageReached = false;
+
+    public PaginatedIterator(PageFetcher<T> fetcher) {
+        this.fetcher = fetcher;
+        loadNextPage();
+    }
+
+    private void loadNextPage() {
+        if (this.lastPageReached) return;
+
+        PaginatedList<T> page = fetcher.fetchNextPage();
+
+        this.lastPageReached = page.isLastPage();
+
+        if (page.hasItems()) {
+            currentIterator = page.iterator();
+        } else {
+            currentIterator = null;
+        }
+    }
+
+    @Override
+    public boolean hasNext() {
+        if (currentIterator != null && currentIterator.hasNext()) {
+            return true;
+        } else if (!this.lastPageReached) {
+            loadNextPage();
+            return hasNext();
+        }
+
+        return false;
+    }
+
+    @Override
+    public T next() {
+        if (!hasNext()) {
+            throw new NoSuchElementException();
+        }
+        return currentIterator.next();
+    }
+}

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/api/paginated/PaginatedList.java

@@ -0,0 +1,51 @@
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2026, CloudBees, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package com.cloudbees.jenkins.plugins.bitbucket.api.paginated;
+
+import java.util.Iterator;
+import java.util.List;
+
+public class PaginatedList<T> implements Iterable<T> {
+
+    private List<T> items;
+    private boolean isLastPage;
+
+    public PaginatedList(List<T> items, boolean isLastPage) {
+        this.items = items;
+        this.isLastPage = isLastPage;
+    }
+
+    public boolean hasItems() {
+        return items != null && !items.isEmpty();
+    }
+
+    public boolean isLastPage() {
+        return isLastPage;
+    }
+
+    @Override
+    public Iterator<T> iterator() {
+        return items.iterator();
+    }
+}