com.palantir.util.paging.AbstractPagingIterable Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of atlasdb-commons Show documentation
Palantir open source project
There is a newer version: 0.1152.0
/*
 * (c) Copyright 2018 Palantir Technologies Inc. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.palantir.util.paging;

import com.google.common.collect.AbstractIterator;
import com.palantir.common.base.Throwables;
import com.palantir.logsafe.Preconditions;
import java.util.Iterator;

/**
 * This class only requires two methods {@link #getFirstPage()} and
 * {@link #getNextPage(BasicResultsPage)} to be implmented to make an iterable.
 *
 * @param  page type
 * @param  data type
 *
 * @author carrino
 */
public abstract class AbstractPagingIterable> implements Iterable {
    @Override
    public PagingIterator iterator() {
        return new PagingIterator(this);
    }

    public static class PagingIterator> extends AbstractIterator {
        private final AbstractPagingIterable iterable;
        private P currentPage = null;
        private Iterator currentIterator = null;
        private volatile P lastPageProcessedInFull = null;

        protected PagingIterator(AbstractPagingIterable iterable) {
            this.iterable = iterable;
        }

        @Override
        protected T computeNext() {
            if (currentPage == null) {
                try {
                    setNextPage(iterable.getFirstPage());
                } catch (Exception e) {
                    throw Throwables.throwUncheckedException(e);
                }
            }
            while (true) {
                if (currentIterator.hasNext()) {
                    return currentIterator.next();
                }

                lastPageProcessedInFull = currentPage;

                if (!currentPage.moreResultsAvailable()) {
                    return endOfData();
                }

                try {
                    setNextPage(iterable.getNextPage(currentPage));
                } catch (Exception e) {
                    throw Throwables.throwUncheckedException(e);
                }
            }
        }

        private void setNextPage(P page) {
            Preconditions.checkNotNull(page);
            currentPage = page;
            currentIterator = page.getResults().iterator();
        }

        /**
         * As this iterator pages through all the results this call will
         * get you the token you can use to get more data at a later date.
         * 

         * This value will be null until this iterator has passed the first page.
         * 
         * This value may be used even if this iterator throws an Exception.
         */
        public P getLastFullPageProcessed() {
            return lastPageProcessedInFull;
        }
    }

    protected abstract P getFirstPage() throws Exception;

    protected abstract P getNextPage(P previous) throws Exception;
}