aboutsummaryrefslogtreecommitdiffstats
path: root/org.eclipse.jgit/src/org/eclipse/jgit/revwalk
diff options
context:
space:
mode:
authorMatthias Sohn <matthias.sohn@sap.com>2015-05-15 23:20:46 +0200
committerMatthias Sohn <matthias.sohn@sap.com>2015-05-15 23:20:46 +0200
commit4cbe66af47a093fb503053ac3aa6e9da01dd3d1b (patch)
tree5802a8a85647daedf7d5e44691fb7ca4cfd4b7df /org.eclipse.jgit/src/org/eclipse/jgit/revwalk
parent0243da320ed6260c61eac07dadc1a7c39904ad1c (diff)
downloadjgit-4cbe66af47a093fb503053ac3aa6e9da01dd3d1b.tar.gz
jgit-4cbe66af47a093fb503053ac3aa6e9da01dd3d1b.zip
Fix warnings in ObjectFilter
- add missing tags in JavaDoc of ObjectFilter.include() - remove unnecessary import Change-Id: I24b9dcc49f66380f77345d704df70c05f7f74db8 Signed-off-by: Matthias Sohn <matthias.sohn@sap.com>
Diffstat (limited to 'org.eclipse.jgit/src/org/eclipse/jgit/revwalk')
-rw-r--r--org.eclipse.jgit/src/org/eclipse/jgit/revwalk/filter/ObjectFilter.java16
1 files changed, 11 insertions, 5 deletions
diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/revwalk/filter/ObjectFilter.java b/org.eclipse.jgit/src/org/eclipse/jgit/revwalk/filter/ObjectFilter.java
index 44ebb9c60d..2ad273d9ec 100644
--- a/org.eclipse.jgit/src/org/eclipse/jgit/revwalk/filter/ObjectFilter.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/revwalk/filter/ObjectFilter.java
@@ -47,7 +47,6 @@ import java.io.IOException;
import org.eclipse.jgit.errors.IncorrectObjectTypeException;
import org.eclipse.jgit.errors.MissingObjectException;
-import org.eclipse.jgit.errors.StopWalkException;
import org.eclipse.jgit.lib.AnyObjectId;
import org.eclipse.jgit.revwalk.ObjectWalk;
@@ -74,12 +73,19 @@ public abstract class ObjectFilter {
* Determine if the named object should be included in the walk.
*
* @param walker
- * the active walker this filter is being invoked from within.
+ * the active walker this filter is being invoked from within.
* @param objid
- * the object currently being tested.
+ * the object currently being tested.
+ * @return {@code true} if the named object should be included in the walk.
+ * @throws MissingObjectException
+ * an object the filter needed to consult to determine its
+ * answer was missing
+ * @throws IncorrectObjectTypeException
+ * an object the filter needed to consult to determine its
+ * answer was of the wrong type
* @throws IOException
- * an object the filter needed to consult to determine its answer
- * was missing, of the wrong type, or could not be read.
+ * an object the filter needed to consult to determine its
+ * answer could not be read.
*/
public abstract boolean include(ObjectWalk walker, AnyObjectId objid)
throws MissingObjectException, IncorrectObjectTypeException,