Later we may want to place other command line programs into different
packages, or permit the user to supply their own from their own JAR
and package namespace.
Signed-off-by: Shawn O. Pearce <spearce@xxxxxxxxxxx>
---
.../src/org/spearce/jgit/pgm/Die.java | 17 +++++++++++-
.../src/org/spearce/jgit/pgm/DiffTree.java | 2 +-
.../src/org/spearce/jgit/pgm/Fetch.java | 2 +-
.../src/org/spearce/jgit/pgm/IndexPack.java | 2 +-
.../src/org/spearce/jgit/pgm/LsRemote.java | 2 +-
.../src/org/spearce/jgit/pgm/LsTree.java | 2 +-
.../src/org/spearce/jgit/pgm/Main.java | 2 +
.../src/org/spearce/jgit/pgm/MergeBase.java | 2 +-
.../src/org/spearce/jgit/pgm/Push.java | 2 +-
.../org/spearce/jgit/pgm/RevWalkTextBuiltin.java | 2 +-
.../src/org/spearce/jgit/pgm/ShowRef.java | 2 +-
.../src/org/spearce/jgit/pgm/Tag.java | 2 +-
.../src/org/spearce/jgit/pgm/TextBuiltin.java | 27 ++++++++++++++++++-
13 files changed, 52 insertions(+), 14 deletions(-)
diff --git a/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/Die.java b/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/Die.java
index b372ff3..3ca898d 100644
--- a/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/Die.java
+++ b/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/Die.java
@@ -37,10 +37,23 @@
package org.spearce.jgit.pgm;
-class Die extends RuntimeException {
+/**
+ * Indicates a {@link TextBuiltin} implementation has failed during execution.
+ * <p>
+ * Typically the stack trace for a Die exception is not shown to the user as it
+ * may indicate a simple error condition that the end-user can fix on their own,
+ * without needing a screen of Java stack frames.
+ */
+public class Die extends RuntimeException {
private static final long serialVersionUID = 1L;
- Die(final String why) {
+ /**
+ * Construct a new message explaining what has gone wrong.
+ *
+ * @param why
+ * the message to show to the end-user.
+ */
+ public Die(final String why) {
super(why);
}
}
diff --git a/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/DiffTree.java b/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/DiffTree.java
index 74e8d2f..17858ba 100644
--- a/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/DiffTree.java
+++ b/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/DiffTree.java
@@ -49,7 +49,7 @@ import org.spearce.jgit.treewalk.filter.TreeFilter;
class DiffTree extends TextBuiltin {
@Override
- void execute(String[] args) throws Exception {
+ public void execute(String[] args) throws Exception {
final TreeWalk walk = new TreeWalk(db);
final List<String> argList = new ArrayList<String>();
List<TreeFilter> pathLimiter = null;
diff --git a/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/Fetch.java b/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/Fetch.java
index 8a35025..e5a0dce 100644
--- a/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/Fetch.java
+++ b/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/Fetch.java
@@ -49,7 +49,7 @@ import org.spearce.jgit.transport.Transport;
class Fetch extends TextBuiltin {
@Override
- void execute(String[] args) throws Exception {
+ public void execute(String[] args) throws Exception {
int argi = 0;
for (; argi < args.length; argi++) {
final String a = args[argi];
diff --git a/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/IndexPack.java b/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/IndexPack.java
index 60926c1..5f4134d 100644
--- a/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/IndexPack.java
+++ b/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/IndexPack.java
@@ -44,7 +44,7 @@ import org.spearce.jgit.lib.TextProgressMonitor;
class IndexPack extends TextBuiltin {
@Override
- void execute(final String[] args) throws Exception {
+ public void execute(final String[] args) throws Exception {
boolean fixThin = false;
int argi = 0;
int version = 0;
diff --git a/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/LsRemote.java b/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/LsRemote.java
index 21e02ec..921bcff 100644
--- a/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/LsRemote.java
+++ b/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/LsRemote.java
@@ -44,7 +44,7 @@ import org.spearce.jgit.transport.Transport;
class LsRemote extends TextBuiltin {
@Override
- void execute(final String[] args) throws Exception {
+ public void execute(final String[] args) throws Exception {
int argi = 0;
for (; argi < args.length; argi++) {
final String a = args[argi];
diff --git a/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/LsTree.java b/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/LsTree.java
index 05ec8c3..a0a7216 100644
--- a/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/LsTree.java
+++ b/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/LsTree.java
@@ -46,7 +46,7 @@ import org.spearce.jgit.treewalk.TreeWalk;
class LsTree extends TextBuiltin {
@Override
- void execute(final String[] args) throws Exception {
+ public void execute(final String[] args) throws Exception {
final TreeWalk walk = new TreeWalk(db);
int argi = 0;
for (; argi < args.length; argi++) {
diff --git a/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/Main.java b/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/Main.java
index 3d507c6..a155039 100644
--- a/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/Main.java
+++ b/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/Main.java
@@ -44,6 +44,8 @@ import java.util.Arrays;
import org.spearce.jgit.awtui.AwtAuthenticator;
import org.spearce.jgit.errors.TransportException;
import org.spearce.jgit.lib.Repository;
+import org.spearce.jgit.pgm.opt.CmdLineParser;
+import org.spearce.jgit.pgm.opt.SubcommandHandler;
import org.spearce.jgit.util.HttpSupport;
/** Command line entry point. */
diff --git a/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/MergeBase.java b/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/MergeBase.java
index c8381f5..c1648a0 100644
--- a/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/MergeBase.java
+++ b/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/MergeBase.java
@@ -43,7 +43,7 @@ import org.spearce.jgit.revwalk.filter.RevFilter;
class MergeBase extends TextBuiltin {
@Override
- void execute(final String[] args) throws Exception {
+ public void execute(final String[] args) throws Exception {
final RevWalk walk = new RevWalk(db);
int max = 1;
for (final String a : args) {
diff --git a/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/Push.java b/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/Push.java
index ef93f2f..5671cc5 100644
--- a/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/Push.java
+++ b/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/Push.java
@@ -55,7 +55,7 @@ class Push extends TextBuiltin {
private boolean first = true;
@Override
- void execute(String[] args) throws Exception {
+ public void execute(String[] args) throws Exception {
final LinkedList<RefSpec> refSpecs = new LinkedList<RefSpec>();
Boolean thin = null;
String exec = null;
diff --git a/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/RevWalkTextBuiltin.java b/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/RevWalkTextBuiltin.java
index b992767..2aba3c5 100644
--- a/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/RevWalkTextBuiltin.java
+++ b/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/RevWalkTextBuiltin.java
@@ -69,7 +69,7 @@ abstract class RevWalkTextBuiltin extends TextBuiltin {
char[] outbuffer = new char[Constants.OBJECT_ID_LENGTH * 2];
@Override
- final void execute(String[] args) throws Exception {
+ public final void execute(String[] args) throws Exception {
final EnumSet<RevSort> sorting = EnumSet.noneOf(RevSort.class);
final List<String> argList = new ArrayList<String>();
final List<RevFilter> revLimiter = new ArrayList<RevFilter>();
diff --git a/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/ShowRef.java b/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/ShowRef.java
index c7cd76e..576e342 100644
--- a/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/ShowRef.java
+++ b/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/ShowRef.java
@@ -44,7 +44,7 @@ import org.spearce.jgit.lib.Ref;
class ShowRef extends TextBuiltin {
@Override
- void execute(String[] args) throws Exception {
+ public void execute(String[] args) throws Exception {
for (final Ref r : new TreeMap<String, Ref>(db.getAllRefs()).values()) {
show(r.getObjectId(), r.getName());
if (r.getPeeledObjectId() != null)
diff --git a/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/Tag.java b/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/Tag.java
index 10b8aa0..d59616b 100644
--- a/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/Tag.java
+++ b/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/Tag.java
@@ -42,7 +42,7 @@ import org.spearce.jgit.lib.PersonIdent;
class Tag extends TextBuiltin {
@Override
- void execute(String[] args) throws Exception {
+ public void execute(String[] args) throws Exception {
String tagName = null;
String message = null;
String ref = "HEAD";
diff --git a/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/TextBuiltin.java b/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/TextBuiltin.java
index b3d8f39..5f2fbce 100644
--- a/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/TextBuiltin.java
+++ b/org.spearce.jgit.pgm/src/org/spearce/jgit/pgm/TextBuiltin.java
@@ -47,15 +47,28 @@ import org.spearce.jgit.lib.Constants;
import org.spearce.jgit.lib.ObjectId;
import org.spearce.jgit.lib.Repository;
-abstract class TextBuiltin {
+/**
+ * Abstract command which can be invoked from the command line.
+ * <p>
+ * Commands are configured with a single "current" repository and then the
+ * {@link #execute(String[])} method is invoked with the arguments that appear
+ * on the command line after the command name.
+ * <p>
+ * Command constructors should perform as little work as possible as they may be
+ * invoked very early during process loading, and the command may not execute
+ * even though it was constructed.
+ */
+public abstract class TextBuiltin {
protected static final String REFS_HEADS = Constants.HEADS_PREFIX + "/";
protected static final String REFS_REMOTES = Constants.REMOTES_PREFIX + "/";
protected static final String REFS_TAGS = Constants.TAGS_PREFIX + "/";
+ /** Stream to output to, typically this is standard output. */
protected PrintWriter out;
+ /** Git repository the command was invoked within. */
protected Repository db;
TextBuiltin() {
@@ -67,7 +80,17 @@ abstract class TextBuiltin {
}
}
- abstract void execute(String[] args) throws Exception;
+ /**
+ * Perform the action(s) of this command.
+ *
+ * @param args
+ * command line arguments passed after the command name.
+ * @throws Exception
+ * an error occurred while processing the command. The main
+ * framework will catch the exception and print a message on
+ * standard error.
+ */
+ public abstract void execute(String[] args) throws Exception;
protected ObjectId resolve(final String s) throws IOException {
final ObjectId r = db.resolve(s);
--
1.5.6.3.569.ga9185
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
