| /* |
| * Copyright (C) 2010, Google Inc. |
| * and other copyright owners as documented in the project's IP log. |
| * |
| * This program and the accompanying materials are made available |
| * under the terms of the Eclipse Distribution License v1.0 which |
| * accompanies this distribution, is reproduced below, and is |
| * available at http://www.eclipse.org/org/documents/edl-v10.php |
| * |
| * All rights reserved. |
| * |
| * Redistribution and use in source and binary forms, with or |
| * without modification, are permitted provided that the following |
| * conditions are met: |
| * |
| * - Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * |
| * - Redistributions in binary form must reproduce the above |
| * copyright notice, this list of conditions and the following |
| * disclaimer in the documentation and/or other materials provided |
| * with the distribution. |
| * |
| * - Neither the name of the Eclipse Foundation, Inc. nor the |
| * names of its contributors may be used to endorse or promote |
| * products derived from this software without specific prior |
| * written permission. |
| * |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND |
| * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, |
| * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR |
| * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
| * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
| * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
| * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, |
| * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF |
| * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| */ |
| |
| package org.eclipse.jgit.lib; |
| |
| import java.io.IOException; |
| |
| import org.eclipse.jgit.errors.MissingObjectException; |
| |
| /** |
| * Queue to examine object sizes asynchronously. |
| * |
| * A queue may perform background lookup of object sizes and supply them |
| * (possibly out-of-order) to the application. |
| * |
| * @param <T> |
| * type of identifier supplied to the call that made the queue. |
| */ |
| public interface AsyncObjectSizeQueue<T extends ObjectId> extends |
| AsyncOperation { |
| |
| /** |
| * Position this queue onto the next available result. |
| * |
| * @return true if there is a result available; false if the queue has |
| * finished its input iteration. |
| * @throws org.eclipse.jgit.errors.MissingObjectException |
| * the object does not exist. If the implementation is retaining |
| * the application's objects {@link #getCurrent()} will be the |
| * current object that is missing. There may be more results |
| * still available, so the caller should continue invoking next |
| * to examine another result. |
| * @throws java.io.IOException |
| * the object store cannot be accessed. |
| */ |
| boolean next() throws MissingObjectException, IOException; |
| |
| /** |
| * <p>getCurrent.</p> |
| * |
| * @return the current object, null if the implementation lost track. |
| * Implementations may for performance reasons discard the caller's |
| * ObjectId and provider their own through {@link #getObjectId()}. |
| */ |
| T getCurrent(); |
| |
| /** |
| * Get the ObjectId of the current object. Never null. |
| * |
| * @return the ObjectId of the current object. Never null. |
| */ |
| ObjectId getObjectId(); |
| |
| /** |
| * Get the size of the current object. |
| * |
| * @return the size of the current object. |
| */ |
| long getSize(); |
| } |