aboutsummaryrefslogtreecommitdiffstats
path: root/org.eclipse.jgit/src/org/eclipse/jgit/lib/AsyncObjectLoaderQueue.java
diff options
context:
space:
mode:
authorMatthias Sohn <matthias.sohn@sap.com>2017-12-18 16:52:40 +0100
committerMatthias Sohn <matthias.sohn@sap.com>2017-12-19 13:43:54 +0100
commit8a6af368c4129ef35520ec72cc9f55a3f685bfb8 (patch)
tree3c11f7c6517247c66fd87bf87571e150d064a84d /org.eclipse.jgit/src/org/eclipse/jgit/lib/AsyncObjectLoaderQueue.java
parentd0342be42d65621e1136936cea9e5072bcfd17a4 (diff)
downloadjgit-8a6af368c4129ef35520ec72cc9f55a3f685bfb8.tar.gz
jgit-8a6af368c4129ef35520ec72cc9f55a3f685bfb8.zip
Fix javadoc in org.eclipse.jgit lib package
Change-Id: I1e85a951488177993521ce177fdea212615e6164 Signed-off-by: Matthias Sohn <matthias.sohn@sap.com>
Diffstat (limited to 'org.eclipse.jgit/src/org/eclipse/jgit/lib/AsyncObjectLoaderQueue.java')
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/lib/AsyncObjectLoaderQueue.java19
1 files changed, 13 insertions, 6 deletions
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/lib/AsyncObjectLoaderQueue.java b/org.eclipse.jgit/src/org/eclipse/jgit/lib/AsyncObjectLoaderQueue.java
index a3732eaacd..b4ea0e907f 100644
--- a/org.eclipse.jgit/src/org/eclipse/jgit/lib/AsyncObjectLoaderQueue.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/lib/AsyncObjectLoaderQueue.java
@@ -63,30 +63,37 @@ public interface AsyncObjectLoaderQueue<T extends ObjectId> extends
* Position this queue onto the next available result.
*
* Even if this method returns true, {@link #open()} may still throw
- * {@link MissingObjectException} if the underlying object database was
- * concurrently modified and the current object is no longer available.
+ * {@link org.eclipse.jgit.errors.MissingObjectException} if the underlying
+ * object database was concurrently modified and the current object is no
+ * longer available.
*
* @return true if there is a result available; false if the queue has
* finished its input iteration.
- * @throws MissingObjectException
+ * @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 IOException
+ * @throws java.io.IOException
* the object store cannot be accessed.
*/
public boolean next() throws MissingObjectException, IOException;
/**
+ * Get the current object, null if the implementation lost track.
+ *
* @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()}.
*/
public T getCurrent();
- /** @return the ObjectId of the current object. Never null. */
+ /**
+ * Get the ObjectId of the current object. Never null.
+ *
+ * @return the ObjectId of the current object. Never null.
+ */
public ObjectId getObjectId();
/**
@@ -105,7 +112,7 @@ public interface AsyncObjectLoaderQueue<T extends ObjectId> extends
* current object that is missing. There may be more results
* still available, so the caller should continue invoking next
* to examine another result.
- * @throws IOException
+ * @throws java.io.IOException
* the object store cannot be accessed.
*/
public ObjectLoader open() throws IOException;