Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRobin Rosenberg2011-09-22 16:27:48 +0000
committerCode Review2011-09-22 16:27:48 +0000
commit51d95bbaea368ff34538943a0de0100e41015852 (patch)
tree8bef156653475d1872bbe547351b1c3ba37ff561 /org.eclipse.jgit.pgm
parent8a45aa460c6f6ecebdfe8aa5715d8cb194478761 (diff)
parenteb8431da757f44e9175716b4c1b08548043463a8 (diff)
downloadjgit-51d95bbaea368ff34538943a0de0100e41015852.tar.gz
jgit-51d95bbaea368ff34538943a0de0100e41015852.tar.xz
jgit-51d95bbaea368ff34538943a0de0100e41015852.zip
Merge "Document the show methods of RevWalkTextBuiltin"
Diffstat (limited to 'org.eclipse.jgit.pgm')
-rw-r--r--org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/RevWalkTextBuiltin.java22
1 files changed, 22 insertions, 0 deletions
diff --git a/org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/RevWalkTextBuiltin.java b/org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/RevWalkTextBuiltin.java
index 50fe31f8f3..d23cbd47ad 100644
--- a/org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/RevWalkTextBuiltin.java
+++ b/org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/RevWalkTextBuiltin.java
@@ -226,8 +226,30 @@ abstract class RevWalkTextBuiltin extends TextBuiltin {
return n;
}
+ /**
+ * "Show" the current RevCommit when called from the main processing loop.
+ * <p>
+ * Implement this methods to define the behavior for subclasses of
+ * RevWalkTextBuiltin.
+ *
+ * @param c
+ * The current {@link RevCommit}
+ * @throws Exception
+ */
protected abstract void show(final RevCommit c) throws Exception;
+ /**
+ * "Show" the current RevCommit when called from the main processing loop.
+ * <p>
+ * The default implementation does nothing because most subclasses only
+ * process RevCommits.
+ *
+ * @param objectWalk
+ * the {@link ObjectWalk} used by {@link #walkLoop()}
+ * @param currentObject
+ * The current {@link RevObject}
+ * @throws Exception
+ */
protected void show(final ObjectWalk objectWalk,
final RevObject currentObject) throws Exception {
// Do nothing by default. Most applications cannot show an object.

Back to the top