001/**
002 * Copyright 2015 DuraSpace, Inc.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.fcrepo.kernel.utils.iterators;
017
018import com.google.common.util.concurrent.ListenableFuture;
019
020/**
021 * Implemented by something that can consume an {@link java.util.Iterator}. The
022 * assumption is that a reference to the appropriate iterator is managed as part
023 * of the state of any implementation.
024 * 
025 * @author ajs6f
026 * @since Oct 24, 2013
027 * @param <E>
028 * @param <T>
029 */
030public interface IteratorConsumer<E, T> {
031
032    /**
033     * Synchronous consumption.
034     */
035    void consume() throws Exception;
036
037    /**
038     * Asynchronous consumption.
039     *
040     * @return ListenableFuture
041     */
042    ListenableFuture<T> consumeAsync();
043
044}