From eb8431da757f44e9175716b4c1b08548043463a8 Mon Sep 17 00:00:00 2001 From: Robin Rosenberg Date: Sun, 18 Sep 2011 13:07:24 +0200 Subject: [PATCH] Document the show methods of RevWalkTextBuiltin Change-Id: Ic704008cb215e1437c0a3fd1aec3aa38209ef3c7 Signed-off-by: Robin Rosenberg --- .../eclipse/jgit/pgm/RevWalkTextBuiltin.java | 22 +++++++++++++++++++ 1 file changed, 22 insertions(+) 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 50fe31f8f..d23cbd47a 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. + *

+ * 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. + *

+ * 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.