motiejus
/
jgit
1
Fork 0
Code Releases Activity

Remove trailing whitespace at end of line 

As discussed on the egit-dev mailing list, we prefer not to have
trailing whitespace in our source code.  Correct all currently
offending lines by trimming them.

Change-Id: I002b1d1980071084c0bc53242c8f5900970e6845
Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
This commit is contained in:
Alex Blewitt 2009-10-19 09:48:00 +01:00 committed by Shawn O. Pearce
parent f3d75800a0
commit 4d91645e89
122 changed files with 652 additions and 652 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/Main.java
View File

@ -79,7 +79,7 @@ public class Main {
/** /**
* Execute the command line. * Execute the command line.
* *
* @param argv * @param argv
* arguments. * arguments.
*/ */

2
org.eclipse.jgit.test/tst/org/eclipse/jgit/dircache/DirCacheTreeTest.java
View File

@ -162,7 +162,7 @@ public void testTwoLevelSubtree() throws Exception {
* index larger than the default BufferedInputStream buffer size. This made * index larger than the default BufferedInputStream buffer size. This made
* the DirCache unable to read the extensions when index size exceeded the * the DirCache unable to read the extensions when index size exceeded the
* buffer size (in some cases at least). * buffer size (in some cases at least).
* *
* @throws CorruptObjectException * @throws CorruptObjectException
* @throws IOException * @throws IOException
*/ */

6
org.eclipse.jgit.test/tst/org/eclipse/jgit/lib/IndexDiffTest.java
View File

@ -94,11 +94,11 @@ public void testRemoved() throws IOException {
public void testModified() throws IOException { public void testModified() throws IOException {
GitIndex index = new GitIndex(db); GitIndex index = new GitIndex(db);
index.add(trash, writeTrashFile("file2", "file2")); index.add(trash, writeTrashFile("file2", "file2"));
index.add(trash, writeTrashFile("dir/file3", "dir/file3")); index.add(trash, writeTrashFile("dir/file3", "dir/file3"));
writeTrashFile("dir/file3", "changed"); writeTrashFile("dir/file3", "changed");
Tree tree = new Tree(db); Tree tree = new Tree(db);

32
org.eclipse.jgit.test/tst/org/eclipse/jgit/lib/IndexTreeWalkerTest.java
View File

@ -54,7 +54,7 @@ public class IndexTreeWalkerTest extends RepositoryTestCase {
private ArrayList<String> treeOnlyEntriesVisited = new ArrayList<String>(); private ArrayList<String> treeOnlyEntriesVisited = new ArrayList<String>();
private ArrayList<String> bothVisited = new ArrayList<String>(); private ArrayList<String> bothVisited = new ArrayList<String>();
private ArrayList<String> indexOnlyEntriesVisited = new ArrayList<String>(); private ArrayList<String> indexOnlyEntriesVisited = new ArrayList<String>();
private class TestIndexTreeVisitor extends AbstractIndexTreeVisitor { private class TestIndexTreeVisitor extends AbstractIndexTreeVisitor {
public void visitEntry(TreeEntry treeEntry, Entry indexEntry, File file) { public void visitEntry(TreeEntry treeEntry, Entry indexEntry, File file) {
if (treeEntry == null) if (treeEntry == null)
@ -67,13 +67,13 @@ else if (indexEntry == null)
/* /*
* Need to think about what I really need to be able to do.... * Need to think about what I really need to be able to do....
* *
* 1) Visit all entries in index and tree * 1) Visit all entries in index and tree
* 2) Get all directories that exist in the index, but not in the tree * 2) Get all directories that exist in the index, but not in the tree
* -- I'm pretty sure that I don't need to do the other way around * -- I'm pretty sure that I don't need to do the other way around
* because I already * because I already
*/ */
public void testTreeOnlyOneLevel() throws IOException { public void testTreeOnlyOneLevel() throws IOException {
GitIndex index = new GitIndex(db); GitIndex index = new GitIndex(db);
Tree tree = new Tree(db); Tree tree = new Tree(db);
@ -81,11 +81,11 @@ public void testTreeOnlyOneLevel() throws IOException {
tree.addFile("bar"); tree.addFile("bar");
new IndexTreeWalker(index, tree, trash, new TestIndexTreeVisitor()).walk(); new IndexTreeWalker(index, tree, trash, new TestIndexTreeVisitor()).walk();
assertTrue(treeOnlyEntriesVisited.get(0).equals("bar")); assertTrue(treeOnlyEntriesVisited.get(0).equals("bar"));
assertTrue(treeOnlyEntriesVisited.get(1).equals("foo")); assertTrue(treeOnlyEntriesVisited.get(1).equals("foo"));
} }
public void testIndexOnlyOneLevel() throws IOException { public void testIndexOnlyOneLevel() throws IOException {
GitIndex index = new GitIndex(db); GitIndex index = new GitIndex(db);
Tree tree = new Tree(db); Tree tree = new Tree(db);
@ -93,11 +93,11 @@ public void testIndexOnlyOneLevel() throws IOException {
index.add(trash, writeTrashFile("foo", "foo")); index.add(trash, writeTrashFile("foo", "foo"));
index.add(trash, writeTrashFile("bar", "bar")); index.add(trash, writeTrashFile("bar", "bar"));
new IndexTreeWalker(index, tree, trash, new TestIndexTreeVisitor()).walk(); new IndexTreeWalker(index, tree, trash, new TestIndexTreeVisitor()).walk();
assertTrue(indexOnlyEntriesVisited.get(0).equals("bar")); assertTrue(indexOnlyEntriesVisited.get(0).equals("bar"));
assertTrue(indexOnlyEntriesVisited.get(1).equals("foo")); assertTrue(indexOnlyEntriesVisited.get(1).equals("foo"));
} }
public void testBoth() throws IOException { public void testBoth() throws IOException {
GitIndex index = new GitIndex(db); GitIndex index = new GitIndex(db);
Tree tree = new Tree(db); Tree tree = new Tree(db);
@ -106,14 +106,14 @@ public void testBoth() throws IOException {
tree.addFile("b/b"); tree.addFile("b/b");
index.add(trash, writeTrashFile("c", "c")); index.add(trash, writeTrashFile("c", "c"));
tree.addFile("c"); tree.addFile("c");
new IndexTreeWalker(index, tree, trash, new TestIndexTreeVisitor()).walk(); new IndexTreeWalker(index, tree, trash, new TestIndexTreeVisitor()).walk();
assertTrue(indexOnlyEntriesVisited.contains("a")); assertTrue(indexOnlyEntriesVisited.contains("a"));
assertTrue(treeOnlyEntriesVisited.contains("b/b")); assertTrue(treeOnlyEntriesVisited.contains("b/b"));
assertTrue(bothVisited.contains("c")); assertTrue(bothVisited.contains("c"));
} }
public void testIndexOnlySubDirs() throws IOException { public void testIndexOnlySubDirs() throws IOException {
GitIndex index = new GitIndex(db); GitIndex index = new GitIndex(db);
Tree tree = new Tree(db); Tree tree = new Tree(db);
@ -121,23 +121,23 @@ public void testIndexOnlySubDirs() throws IOException {
index.add(trash, writeTrashFile("foo/bar/baz", "foobar")); index.add(trash, writeTrashFile("foo/bar/baz", "foobar"));
index.add(trash, writeTrashFile("asdf", "asdf")); index.add(trash, writeTrashFile("asdf", "asdf"));
new IndexTreeWalker(index, tree, trash, new TestIndexTreeVisitor()).walk(); new IndexTreeWalker(index, tree, trash, new TestIndexTreeVisitor()).walk();
assertEquals("asdf", indexOnlyEntriesVisited.get(0)); assertEquals("asdf", indexOnlyEntriesVisited.get(0));
assertEquals("foo/bar/baz", indexOnlyEntriesVisited.get(1)); assertEquals("foo/bar/baz", indexOnlyEntriesVisited.get(1));
} }
public void testLeavingTree() throws IOException { public void testLeavingTree() throws IOException {
GitIndex index = new GitIndex(db); GitIndex index = new GitIndex(db);
index.add(trash, writeTrashFile("foo/bar", "foo/bar")); index.add(trash, writeTrashFile("foo/bar", "foo/bar"));
index.add(trash, writeTrashFile("foobar", "foobar")); index.add(trash, writeTrashFile("foobar", "foobar"));
new IndexTreeWalker(index, db.mapTree(index.writeTree()), trash, new AbstractIndexTreeVisitor() { new IndexTreeWalker(index, db.mapTree(index.writeTree()), trash, new AbstractIndexTreeVisitor() {
@Override @Override
public void visitEntry(TreeEntry entry, Entry indexEntry, File f) { public void visitEntry(TreeEntry entry, Entry indexEntry, File f) {
if (entry == null || indexEntry == null) if (entry == null || indexEntry == null)
fail(); fail();
} }
@Override @Override
public void finishVisitTree(Tree tree, int i, String curDir) public void finishVisitTree(Tree tree, int i, String curDir)
throws IOException { throws IOException {
@ -146,7 +146,7 @@ public void finishVisitTree(Tree tree, int i, String curDir)
if (i == 0) if (i == 0)
fail(); fail();
} }
}).walk(); }).walk();
} }
} }

4
org.eclipse.jgit.test/tst/org/eclipse/jgit/lib/PackIndexTestCase.java
View File

@ -64,14 +64,14 @@ public void setUp() throws Exception {
/** /**
* Return file with appropriate index version for prepared pack. * Return file with appropriate index version for prepared pack.
* *
* @return file with index * @return file with index
*/ */
public abstract File getFileForPack34be9032(); public abstract File getFileForPack34be9032();
/** /**
* Return file with appropriate index version for prepared pack. * Return file with appropriate index version for prepared pack.
* *
* @return file with index * @return file with index
*/ */
public abstract File getFileForPackdf2982f28(); public abstract File getFileForPackdf2982f28();

152
org.eclipse.jgit.test/tst/org/eclipse/jgit/lib/ReadTreeTest.java
View File

@ -54,7 +54,7 @@
import org.eclipse.jgit.errors.CheckoutConflictException; import org.eclipse.jgit.errors.CheckoutConflictException;
public class ReadTreeTest extends RepositoryTestCase { public class ReadTreeTest extends RepositoryTestCase {
private Tree theHead; private Tree theHead;
private Tree theMerge; private Tree theMerge;
private GitIndex theIndex; private GitIndex theIndex;
@ -64,64 +64,64 @@ public class ReadTreeTest extends RepositoryTestCase {
// Rule 0 is left out for obvious reasons :) // Rule 0 is left out for obvious reasons :)
public void testRules1thru3_NoIndexEntry() throws IOException { public void testRules1thru3_NoIndexEntry() throws IOException {
GitIndex index = new GitIndex(db); GitIndex index = new GitIndex(db);
Tree head = new Tree(db); Tree head = new Tree(db);
FileTreeEntry headFile = head.addFile("foo"); FileTreeEntry headFile = head.addFile("foo");
ObjectId objectId = ObjectId.fromString("ba78e065e2c261d4f7b8f42107588051e87e18e9"); ObjectId objectId = ObjectId.fromString("ba78e065e2c261d4f7b8f42107588051e87e18e9");
headFile.setId(objectId); headFile.setId(objectId);
Tree merge = new Tree(db); Tree merge = new Tree(db);
WorkDirCheckout readTree = new WorkDirCheckout(db, trash, head, index, merge); WorkDirCheckout readTree = new WorkDirCheckout(db, trash, head, index, merge);
readTree.prescanTwoTrees(); readTree.prescanTwoTrees();
assertTrue(readTree.removed.contains("foo")); assertTrue(readTree.removed.contains("foo"));
readTree = new WorkDirCheckout(db, trash, merge, index, head); readTree = new WorkDirCheckout(db, trash, merge, index, head);
readTree.prescanTwoTrees(); readTree.prescanTwoTrees();
assertEquals(objectId, readTree.updated.get("foo")); assertEquals(objectId, readTree.updated.get("foo"));
ObjectId anotherId = ObjectId.fromString("ba78e065e2c261d4f7b8f42107588051e87e18ee"); ObjectId anotherId = ObjectId.fromString("ba78e065e2c261d4f7b8f42107588051e87e18ee");
merge.addFile("foo").setId(anotherId); merge.addFile("foo").setId(anotherId);
readTree = new WorkDirCheckout(db, trash, head, index, merge); readTree = new WorkDirCheckout(db, trash, head, index, merge);
readTree.prescanTwoTrees(); readTree.prescanTwoTrees();
assertEquals(anotherId, readTree.updated.get("foo")); assertEquals(anotherId, readTree.updated.get("foo"));
} }
void setupCase(HashMap<String, String> headEntries, void setupCase(HashMap<String, String> headEntries,
HashMap<String, String> mergeEntries, HashMap<String, String> mergeEntries,
HashMap<String, String> indexEntries) throws IOException { HashMap<String, String> indexEntries) throws IOException {
theHead = buildTree(headEntries); theHead = buildTree(headEntries);
theMerge = buildTree(mergeEntries); theMerge = buildTree(mergeEntries);
theIndex = buildIndex(indexEntries); theIndex = buildIndex(indexEntries);
} }
private GitIndex buildIndex(HashMap<String, String> indexEntries) throws IOException { private GitIndex buildIndex(HashMap<String, String> indexEntries) throws IOException {
GitIndex index = new GitIndex(db); GitIndex index = new GitIndex(db);
if (indexEntries == null) if (indexEntries == null)
return index; return index;
for (java.util.Map.Entry<String,String> e : indexEntries.entrySet()) { for (java.util.Map.Entry<String,String> e : indexEntries.entrySet()) {
index.add(trash, writeTrashFile(e.getKey(), e.getValue())).forceRecheck(); index.add(trash, writeTrashFile(e.getKey(), e.getValue())).forceRecheck();
} }
return index; return index;
} }
private Tree buildTree(HashMap<String, String> headEntries) throws IOException { private Tree buildTree(HashMap<String, String> headEntries) throws IOException {
Tree tree = new Tree(db); Tree tree = new Tree(db);
if (headEntries == null) if (headEntries == null)
return tree; return tree;
for (java.util.Map.Entry<String,String> e : headEntries.entrySet()) { for (java.util.Map.Entry<String,String> e : headEntries.entrySet()) {
tree.addFile(e.getKey()).setId(genSha1(e.getValue())); tree.addFile(e.getKey()).setId(genSha1(e.getValue()));
} }
return tree; return tree;
} }
ObjectId genSha1(String data) { ObjectId genSha1(String data) {
InputStream is = new ByteArrayInputStream(data.getBytes()); InputStream is = new ByteArrayInputStream(data.getBytes());
ObjectWriter objectWriter = new ObjectWriter(db); ObjectWriter objectWriter = new ObjectWriter(db);
@ -133,7 +133,7 @@ ObjectId genSha1(String data) {
} }
return null; return null;
} }
private WorkDirCheckout go() throws IOException { private WorkDirCheckout go() throws IOException {
theReadTree = new WorkDirCheckout(db, trash, theHead, theIndex, theMerge); theReadTree = new WorkDirCheckout(db, trash, theHead, theIndex, theMerge);
theReadTree.prescanTwoTrees(); theReadTree.prescanTwoTrees();
@ -151,11 +151,11 @@ public void testRules4thru13_IndexEntryNotInHead() throws IOException {
idxMap.put("foo", "foo"); idxMap.put("foo", "foo");
setupCase(null, null, idxMap); setupCase(null, null, idxMap);
theReadTree = go(); theReadTree = go();
assertTrue(theReadTree.updated.isEmpty()); assertTrue(theReadTree.updated.isEmpty());
assertTrue(theReadTree.removed.isEmpty()); assertTrue(theReadTree.removed.isEmpty());
assertTrue(theReadTree.conflicts.isEmpty()); assertTrue(theReadTree.conflicts.isEmpty());
// rules 6 and 7 // rules 6 and 7
idxMap = new HashMap<String, String>(); idxMap = new HashMap<String, String>();
idxMap.put("foo", "foo"); idxMap.put("foo", "foo");
@ -163,70 +163,70 @@ public void testRules4thru13_IndexEntryNotInHead() throws IOException {
theReadTree = go(); theReadTree = go();
assertAllEmpty(); assertAllEmpty();
// rules 8 and 9 // rules 8 and 9
HashMap<String, String> mergeMap; HashMap<String, String> mergeMap;
mergeMap = new HashMap<String, String>(); mergeMap = new HashMap<String, String>();
mergeMap.put("foo", "merge"); mergeMap.put("foo", "merge");
setupCase(null, mergeMap, idxMap); setupCase(null, mergeMap, idxMap);
go(); go();
assertTrue(theReadTree.updated.isEmpty()); assertTrue(theReadTree.updated.isEmpty());
assertTrue(theReadTree.removed.isEmpty()); assertTrue(theReadTree.removed.isEmpty());
assertTrue(theReadTree.conflicts.contains("foo")); assertTrue(theReadTree.conflicts.contains("foo"));
// rule 10 // rule 10
HashMap<String, String> headMap = new HashMap<String, String>(); HashMap<String, String> headMap = new HashMap<String, String>();
headMap.put("foo", "foo"); headMap.put("foo", "foo");
setupCase(headMap, null, idxMap); setupCase(headMap, null, idxMap);
go(); go();
assertTrue(theReadTree.removed.contains("foo")); assertTrue(theReadTree.removed.contains("foo"));
assertTrue(theReadTree.updated.isEmpty()); assertTrue(theReadTree.updated.isEmpty());
assertTrue(theReadTree.conflicts.isEmpty()); assertTrue(theReadTree.conflicts.isEmpty());
// rule 11 // rule 11
setupCase(headMap, null, idxMap); setupCase(headMap, null, idxMap);
new File(trash, "foo").delete(); new File(trash, "foo").delete();
writeTrashFile("foo", "bar"); writeTrashFile("foo", "bar");
theIndex.getMembers()[0].forceRecheck(); theIndex.getMembers()[0].forceRecheck();
go(); go();
assertTrue(theReadTree.removed.isEmpty()); assertTrue(theReadTree.removed.isEmpty());
assertTrue(theReadTree.updated.isEmpty()); assertTrue(theReadTree.updated.isEmpty());
assertTrue(theReadTree.conflicts.contains("foo")); assertTrue(theReadTree.conflicts.contains("foo"));
// rule 12 & 13 // rule 12 & 13
headMap.put("foo", "head"); headMap.put("foo", "head");
setupCase(headMap, null, idxMap); setupCase(headMap, null, idxMap);
go(); go();
assertTrue(theReadTree.removed.isEmpty()); assertTrue(theReadTree.removed.isEmpty());
assertTrue(theReadTree.updated.isEmpty()); assertTrue(theReadTree.updated.isEmpty());
assertTrue(theReadTree.conflicts.contains("foo")); assertTrue(theReadTree.conflicts.contains("foo"));
// rules 14 & 15 // rules 14 & 15
setupCase(headMap, headMap, idxMap); setupCase(headMap, headMap, idxMap);
go(); go();
assertAllEmpty(); assertAllEmpty();
// rules 16 & 17 // rules 16 & 17
setupCase(headMap, mergeMap, idxMap); go(); setupCase(headMap, mergeMap, idxMap); go();
assertTrue(theReadTree.conflicts.contains("foo")); assertTrue(theReadTree.conflicts.contains("foo"));
// rules 18 & 19 // rules 18 & 19
setupCase(headMap, idxMap, idxMap); go(); setupCase(headMap, idxMap, idxMap); go();
assertAllEmpty(); assertAllEmpty();
// rule 20 // rule 20
setupCase(idxMap, mergeMap, idxMap); go(); setupCase(idxMap, mergeMap, idxMap); go();
assertTrue(theReadTree.updated.containsKey("foo")); assertTrue(theReadTree.updated.containsKey("foo"));
// rules 21 // rules 21
setupCase(idxMap, mergeMap, idxMap); setupCase(idxMap, mergeMap, idxMap);
new File(trash, "foo").delete(); new File(trash, "foo").delete();
writeTrashFile("foo", "bar"); writeTrashFile("foo", "bar");
theIndex.getMembers()[0].forceRecheck(); theIndex.getMembers()[0].forceRecheck();
@ -239,37 +239,37 @@ private void assertAllEmpty() {
assertTrue(theReadTree.updated.isEmpty()); assertTrue(theReadTree.updated.isEmpty());
assertTrue(theReadTree.conflicts.isEmpty()); assertTrue(theReadTree.conflicts.isEmpty());
} }
public void testDirectoryFileSimple() throws IOException { public void testDirectoryFileSimple() throws IOException {
theIndex = new GitIndex(db); theIndex = new GitIndex(db);
theIndex.add(trash, writeTrashFile("DF", "DF")); theIndex.add(trash, writeTrashFile("DF", "DF"));
Tree treeDF = db.mapTree(theIndex.writeTree()); Tree treeDF = db.mapTree(theIndex.writeTree());
recursiveDelete(new File(trash, "DF")); recursiveDelete(new File(trash, "DF"));
theIndex = new GitIndex(db); theIndex = new GitIndex(db);
theIndex.add(trash, writeTrashFile("DF/DF", "DF/DF")); theIndex.add(trash, writeTrashFile("DF/DF", "DF/DF"));
Tree treeDFDF = db.mapTree(theIndex.writeTree()); Tree treeDFDF = db.mapTree(theIndex.writeTree());
theIndex = new GitIndex(db); theIndex = new GitIndex(db);
recursiveDelete(new File(trash, "DF")); recursiveDelete(new File(trash, "DF"));
theIndex.add(trash, writeTrashFile("DF", "DF")); theIndex.add(trash, writeTrashFile("DF", "DF"));
theReadTree = new WorkDirCheckout(db, trash, treeDF, theIndex, treeDFDF); theReadTree = new WorkDirCheckout(db, trash, treeDF, theIndex, treeDFDF);
theReadTree.prescanTwoTrees(); theReadTree.prescanTwoTrees();
assertTrue(theReadTree.removed.contains("DF")); assertTrue(theReadTree.removed.contains("DF"));
assertTrue(theReadTree.updated.containsKey("DF/DF")); assertTrue(theReadTree.updated.containsKey("DF/DF"));
recursiveDelete(new File(trash, "DF")); recursiveDelete(new File(trash, "DF"));
theIndex = new GitIndex(db); theIndex = new GitIndex(db);
theIndex.add(trash, writeTrashFile("DF/DF", "DF/DF")); theIndex.add(trash, writeTrashFile("DF/DF", "DF/DF"));
theReadTree = new WorkDirCheckout(db, trash, treeDFDF, theIndex, treeDF); theReadTree = new WorkDirCheckout(db, trash, treeDFDF, theIndex, treeDF);
theReadTree.prescanTwoTrees(); theReadTree.prescanTwoTrees();
assertTrue(theReadTree.removed.contains("DF/DF")); assertTrue(theReadTree.removed.contains("DF/DF"));
assertTrue(theReadTree.updated.containsKey("DF")); assertTrue(theReadTree.updated.containsKey("DF"));
} }
/* /*
* Directory/File Conflict cases: * Directory/File Conflict cases:
* It's entirely possible that in practice a number of these may be equivalent * It's entirely possible that in practice a number of these may be equivalent
@ -277,7 +277,7 @@ public void testDirectoryFileSimple() throws IOException {
* that's all I care about. These are basically reverse-engineered from * that's all I care about. These are basically reverse-engineered from
* what git currently does. If there are tests for these in git, it's kind of * what git currently does. If there are tests for these in git, it's kind of
* hard to track them all down... * hard to track them all down...
* *
* H I M Clean H==M H==I I==M Result * H I M Clean H==M H==I I==M Result
* ------------------------------------------------------------------ * ------------------------------------------------------------------
*1 D D F Y N Y N Update *1 D D F Y N Y N Update
@ -290,7 +290,7 @@ public void testDirectoryFileSimple() throws IOException {
*8 F D F N Y N N Conflict *8 F D F N Y N N Conflict
*9 F D F Y N N N Update *9 F D F Y N N N Update
*10 F D D N N Y Keep *10 F D D N N Y Keep
*11 F D D N N N Conflict *11 F D D N N N Conflict
*12 F F D Y N Y N Update *12 F F D Y N Y N Update
*13 F F D N N Y N Conflict *13 F F D N N Y N Conflict
*14 F F D N N N Conflict *14 F F D N N N Conflict
@ -300,7 +300,7 @@ public void testDirectoryFileSimple() throws IOException {
*18 F 0 D Update *18 F 0 D Update
*19 D 0 F Update *19 D 0 F Update
*/ */
public void testDirectoryFileConflicts_1() throws Exception { public void testDirectoryFileConflicts_1() throws Exception {
// 1 // 1
doit(mk("DF/DF"), mk("DF"), mk("DF/DF")); doit(mk("DF/DF"), mk("DF"), mk("DF/DF"));
@ -315,7 +315,7 @@ public void testDirectoryFileConflicts_2() throws Exception {
writeTrashFile("DF/DF", "different"); writeTrashFile("DF/DF", "different");
go(); go();
assertConflict("DF/DF"); assertConflict("DF/DF");
} }
public void testDirectoryFileConflicts_3() throws Exception { public void testDirectoryFileConflicts_3() throws Exception {
@ -330,14 +330,14 @@ public void testDirectoryFileConflicts_4() throws Exception {
doit(mk("DF/DF"), mkmap("DF/DF", "foo"), mk("DF")); doit(mk("DF/DF"), mkmap("DF/DF", "foo"), mk("DF"));
assertUpdated("DF/DF"); assertUpdated("DF/DF");
assertRemoved("DF"); assertRemoved("DF");
} }
public void testDirectoryFileConflicts_5() throws Exception { public void testDirectoryFileConflicts_5() throws Exception {
// 5 // 5
doit(mk("DF/DF"), mk("DF"), mk("DF")); doit(mk("DF/DF"), mk("DF"), mk("DF"));
assertRemoved("DF/DF"); assertRemoved("DF/DF");
} }
public void testDirectoryFileConflicts_6() throws Exception { public void testDirectoryFileConflicts_6() throws Exception {
@ -359,7 +359,7 @@ public void testDirectoryFileConflicts_7() throws Exception {
go(); go();
assertRemoved("DF/DF/DF/DF/DF"); assertRemoved("DF/DF/DF/DF/DF");
assertUpdated("DF/DF"); assertUpdated("DF/DF");
cleanUpDF(); cleanUpDF();
setupCase(mk("DF/DF"), mk("DF/DF"), mk("DF/DF/DF/DF/DF")); setupCase(mk("DF/DF"), mk("DF/DF"), mk("DF/DF/DF/DF/DF"));
writeTrashFile("DF/DF/DF/DF/DF", "diff"); writeTrashFile("DF/DF/DF/DF/DF", "diff");
@ -383,7 +383,7 @@ public void testDirectoryFileConflicts_10() throws Exception {
cleanUpDF(); cleanUpDF();
doit(mk("DF"), mk("DF/DF"), mk("DF/DF")); doit(mk("DF"), mk("DF/DF"), mk("DF/DF"));
assertNoConflicts(); assertNoConflicts();
} }
public void testDirectoryFileConflicts_11() throws Exception { public void testDirectoryFileConflicts_11() throws Exception {
@ -471,19 +471,19 @@ private void cleanUpDF() throws Exception {
setUp(); setUp();
recursiveDelete(new File(trash, "DF")); recursiveDelete(new File(trash, "DF"));
} }
private void assertConflict(String s) { private void assertConflict(String s) {
assertTrue(theReadTree.conflicts.contains(s)); assertTrue(theReadTree.conflicts.contains(s));
} }
private void assertUpdated(String s) { private void assertUpdated(String s) {
assertTrue(theReadTree.updated.containsKey(s)); assertTrue(theReadTree.updated.containsKey(s));
} }
private void assertRemoved(String s) { private void assertRemoved(String s) {
assertTrue(theReadTree.removed.contains(s)); assertTrue(theReadTree.removed.contains(s));
} }
private void assertNoConflicts() { private void assertNoConflicts() {
assertTrue(theReadTree.conflicts.isEmpty()); assertTrue(theReadTree.conflicts.isEmpty());
} }
@ -493,30 +493,30 @@ private void doit(HashMap<String, String> h, HashMap<String, String>m,
setupCase(h, m, i); setupCase(h, m, i);
go(); go();
} }
private static HashMap<String, String> mk(String a) { private static HashMap<String, String> mk(String a) {
return mkmap(a, a); return mkmap(a, a);
} }
private static HashMap<String, String> mkmap(String... args) { private static HashMap<String, String> mkmap(String... args) {
if ((args.length % 2) > 0) if ((args.length % 2) > 0)
throw new IllegalArgumentException("needs to be pairs"); throw new IllegalArgumentException("needs to be pairs");
HashMap<String, String> map = new HashMap<String, String>(); HashMap<String, String> map = new HashMap<String, String>();
for (int i = 0; i < args.length; i += 2) { for (int i = 0; i < args.length; i += 2) {
map.put(args[i], args[i+1]); map.put(args[i], args[i+1]);
} }
return map; return map;
} }
public void testUntrackedConflicts() throws IOException { public void testUntrackedConflicts() throws IOException {
setupCase(null, mk("foo"), null); setupCase(null, mk("foo"), null);
writeTrashFile("foo", "foo"); writeTrashFile("foo", "foo");
go(); go();
assertConflict("foo"); assertConflict("foo");
recursiveDelete(new File(trash, "foo")); recursiveDelete(new File(trash, "foo"));
setupCase(null, mk("foo"), null); setupCase(null, mk("foo"), null);
writeTrashFile("foo/bar/baz", ""); writeTrashFile("foo/bar/baz", "");
@ -525,14 +525,14 @@ public void testUntrackedConflicts() throws IOException {
assertConflict("foo/bar/baz"); assertConflict("foo/bar/baz");
assertConflict("foo/blahblah"); assertConflict("foo/blahblah");
recursiveDelete(new File(trash, "foo")); recursiveDelete(new File(trash, "foo"));
setupCase(mkmap("foo/bar", "", "foo/baz", ""), setupCase(mkmap("foo/bar", "", "foo/baz", ""),
mk("foo"), mkmap("foo/bar", "", "foo/baz", "")); mk("foo"), mkmap("foo/bar", "", "foo/baz", ""));
assertTrue(new File(trash, "foo/bar").exists()); assertTrue(new File(trash, "foo/bar").exists());
go(); go();
assertNoConflicts(); assertNoConflicts();
} }
@ -554,23 +554,23 @@ private void checkout() throws IOException {
theReadTree = new WorkDirCheckout(db, trash, theHead, theIndex, theMerge); theReadTree = new WorkDirCheckout(db, trash, theHead, theIndex, theMerge);
theReadTree.checkout(); theReadTree.checkout();
} }
public void testCheckoutOutChanges() throws IOException { public void testCheckoutOutChanges() throws IOException {
setupCase(mk("foo"), mk("foo/bar"), mk("foo")); setupCase(mk("foo"), mk("foo/bar"), mk("foo"));
checkout(); checkout();
assertFalse(new File(trash, "foo").isFile()); assertFalse(new File(trash, "foo").isFile());
assertTrue(new File(trash, "foo/bar").isFile()); assertTrue(new File(trash, "foo/bar").isFile());
recursiveDelete(new File(trash, "foo")); recursiveDelete(new File(trash, "foo"));
setupCase(mk("foo/bar"), mk("foo"), mk("foo/bar")); setupCase(mk("foo/bar"), mk("foo"), mk("foo/bar"));
checkout(); checkout();
assertFalse(new File(trash, "foo/bar").isFile()); assertFalse(new File(trash, "foo/bar").isFile());
assertTrue(new File(trash, "foo").isFile()); assertTrue(new File(trash, "foo").isFile());
setupCase(mk("foo"), mkmap("foo", "qux"), mkmap("foo", "bar")); setupCase(mk("foo"), mkmap("foo", "qux"), mkmap("foo", "bar"));
try { try {
checkout(); checkout();
fail("did not throw exception"); fail("did not throw exception");

12
org.eclipse.jgit.test/tst/org/eclipse/jgit/lib/T0003_Basic.java
View File

@ -276,10 +276,10 @@ public void test020b_createBlobPlainTag() throws IOException {
t.setTag("test020b"); t.setTag("test020b");
t.setObjId(ObjectId.fromString("e69de29bb2d1d6434b8b29ae775ad8c2e48c5391")); t.setObjId(ObjectId.fromString("e69de29bb2d1d6434b8b29ae775ad8c2e48c5391"));
t.tag(); t.tag();
Tag mapTag = db.mapTag("test020b"); Tag mapTag = db.mapTag("test020b");
assertEquals("e69de29bb2d1d6434b8b29ae775ad8c2e48c5391", mapTag.getObjId().name()); assertEquals("e69de29bb2d1d6434b8b29ae775ad8c2e48c5391", mapTag.getObjId().name());
// We do not repeat the plain tag test for other object types // We do not repeat the plain tag test for other object types
} }
@ -330,7 +330,7 @@ public void test022_createCommitTag() throws IOException {
assertEquals(new PersonIdent(jauthor, 1154236443000L, -4 * 60), mapTag.getAuthor()); assertEquals(new PersonIdent(jauthor, 1154236443000L, -4 * 60), mapTag.getAuthor());
assertEquals("b5d3b45a96b340441f5abb9080411705c51cc86c", mapTag.getObjId().name()); assertEquals("b5d3b45a96b340441f5abb9080411705c51cc86c", mapTag.getObjId().name());
} }
public void test023_createCommitNonAnullii() throws IOException { public void test023_createCommitNonAnullii() throws IOException {
final ObjectId emptyId = new ObjectWriter(db).writeBlob(new byte[0]); final ObjectId emptyId = new ObjectWriter(db).writeBlob(new byte[0]);
final Tree almostEmptyTree = new Tree(db); final Tree almostEmptyTree = new Tree(db);
@ -363,7 +363,7 @@ public void test024_createCommitNonAscii() throws IOException {
ObjectId cid = new ObjectWriter(db).writeCommit(commit); ObjectId cid = new ObjectWriter(db).writeCommit(commit);
assertEquals("2979b39d385014b33287054b87f77bcb3ecb5ebf", cid.name()); assertEquals("2979b39d385014b33287054b87f77bcb3ecb5ebf", cid.name());
} }
public void test025_packedRefs() throws IOException { public void test025_packedRefs() throws IOException {
test020_createBlobTag(); test020_createBlobTag();
test021_createTreeTag(); test021_createTreeTag();
@ -502,9 +502,9 @@ public void test026_CreateCommitMultipleparents() throws IOException {
assertEquals(c2.getCommitId(), rm4.getParentIds()[1]); assertEquals(c2.getCommitId(), rm4.getParentIds()[1]);
assertEquals(c3.getCommitId(), rm4.getParentIds()[2]); assertEquals(c3.getCommitId(), rm4.getParentIds()[2]);
} }
public void test027_UnpackedRefHigherPriorityThanPacked() throws IOException { public void test027_UnpackedRefHigherPriorityThanPacked() throws IOException {
PrintWriter writer = new PrintWriter(new FileWriter(new File(db.getDirectory(), "refs/heads/a"))); PrintWriter writer = new PrintWriter(new FileWriter(new File(db.getDirectory(), "refs/heads/a")));
String unpackedId = "7f822839a2fe9760f386cbbbcb3f92c5fe81def7"; String unpackedId = "7f822839a2fe9760f386cbbbcb3f92c5fe81def7";
writer.print(unpackedId); writer.print(unpackedId);
writer.print('\n'); writer.print('\n');

2
org.eclipse.jgit.test/tst/org/eclipse/jgit/lib/T0007_Index.java
View File

@ -179,7 +179,7 @@ public void testWriteTree() throws Exception {
ObjectId id = index.writeTree(); ObjectId id = index.writeTree();
assertEquals("c696abc3ab8e091c665f49d00eb8919690b3aec3", id.name()); assertEquals("c696abc3ab8e091c665f49d00eb8919690b3aec3", id.name());
writeTrashFile("a/b", "data:a/b"); writeTrashFile("a/b", "data:a/b");
index.add(trash, new File(trash, "a/b")); index.add(trash, new File(trash, "a/b"));

8
org.eclipse.jgit.test/tst/org/eclipse/jgit/lib/TreeIteratorLeafOnlyTest.java
View File

@ -57,7 +57,7 @@ public void testEmpty() {
/** /**
* one file * one file
* *
* @throws IOException * @throws IOException
*/ */
public void testSimpleF1() throws IOException { public void testSimpleF1() throws IOException {
@ -70,7 +70,7 @@ public void testSimpleF1() throws IOException {
/** /**
* two files * two files
* *
* @throws IOException * @throws IOException
*/ */
public void testSimpleF2() throws IOException { public void testSimpleF2() throws IOException {
@ -85,7 +85,7 @@ public void testSimpleF2() throws IOException {
/** /**
* Empty tree * Empty tree
* *
* @throws IOException * @throws IOException
*/ */
public void testSimpleT() throws IOException { public void testSimpleT() throws IOException {
@ -94,7 +94,7 @@ public void testSimpleT() throws IOException {
TreeIterator i = makeIterator(tree); TreeIterator i = makeIterator(tree);
assertFalse(i.hasNext()); assertFalse(i.hasNext());
} }
public void testTricky() throws IOException { public void testTricky() throws IOException {
Tree tree = new Tree(db); Tree tree = new Tree(db);
tree.addFile("a.b"); tree.addFile("a.b");

8
org.eclipse.jgit.test/tst/org/eclipse/jgit/lib/TreeIteratorPostOrderTest.java
View File

@ -59,7 +59,7 @@ public void testEmpty() {
/** /**
* one file * one file
* *
* @throws IOException * @throws IOException
*/ */
public void testSimpleF1() throws IOException { public void testSimpleF1() throws IOException {
@ -75,7 +75,7 @@ public void testSimpleF1() throws IOException {
/** /**
* two files * two files
* *
* @throws IOException * @throws IOException
*/ */
public void testSimpleF2() throws IOException { public void testSimpleF2() throws IOException {
@ -93,7 +93,7 @@ public void testSimpleF2() throws IOException {
/** /**
* Empty tree * Empty tree
* *
* @throws IOException * @throws IOException
*/ */
public void testSimpleT() throws IOException { public void testSimpleT() throws IOException {
@ -106,7 +106,7 @@ public void testSimpleT() throws IOException {
assertEquals("", i.next().getFullName()); assertEquals("", i.next().getFullName());
assertFalse(i.hasNext()); assertFalse(i.hasNext());
} }
public void testTricky() throws IOException { public void testTricky() throws IOException {
Tree tree = new Tree(db); Tree tree = new Tree(db);
tree.addFile("a.b"); tree.addFile("a.b");

8
org.eclipse.jgit.test/tst/org/eclipse/jgit/lib/TreeIteratorPreOrderTest.java
View File

@ -59,7 +59,7 @@ public void testEmpty() {
/** /**
* one file * one file
* *
* @throws IOException * @throws IOException
*/ */
public void testSimpleF1() throws IOException { public void testSimpleF1() throws IOException {
@ -75,7 +75,7 @@ public void testSimpleF1() throws IOException {
/** /**
* two files * two files
* *
* @throws IOException * @throws IOException
*/ */
public void testSimpleF2() throws IOException { public void testSimpleF2() throws IOException {
@ -93,7 +93,7 @@ public void testSimpleF2() throws IOException {
/** /**
* Empty tree * Empty tree
* *
* @throws IOException * @throws IOException
*/ */
public void testSimpleT() throws IOException { public void testSimpleT() throws IOException {
@ -106,7 +106,7 @@ public void testSimpleT() throws IOException {
assertEquals("a", i.next().getFullName()); assertEquals("a", i.next().getFullName());
assertFalse(i.hasNext()); assertFalse(i.hasNext());
} }
public void testTricky() throws IOException { public void testTricky() throws IOException {
Tree tree = new Tree(db); Tree tree = new Tree(db);
tree.addFile("a.b"); tree.addFile("a.b");

2
org.eclipse.jgit.test/tst/org/eclipse/jgit/transport/BundleWriterTest.java
View File

@ -89,7 +89,7 @@ public void testWrite0() throws Exception {
/** /**
* Incremental bundle test * Incremental bundle test
* *
* @throws Exception * @throws Exception
*/ */
public void testWrite1() throws Exception { public void testWrite1() throws Exception {

2
org.eclipse.jgit/src/org/eclipse/jgit/awtui/AWTPlotRenderer.java
View File

@ -187,4 +187,4 @@ protected int drawLabel(int x, int y, Ref ref) {
return arcHeight * 3 + textw; return arcHeight * 3 + textw;
} }
} }

4
org.eclipse.jgit/src/org/eclipse/jgit/awtui/AwtAuthenticator.java
View File

@ -69,7 +69,7 @@ public static void install() {
/** /**
* Add a cached authentication for future use. * Add a cached authentication for future use.
* *
* @param ca * @param ca
* the information we should remember. * the information we should remember.
*/ */
@ -172,7 +172,7 @@ public static class CachedAuthentication {
/** /**
* Create a new cached authentication. * Create a new cached authentication.
* *
* @param aHost * @param aHost
* system this is for. * system this is for.
* @param aPort * @param aPort

2
org.eclipse.jgit/src/org/eclipse/jgit/awtui/CommitGraphPane.java
View File

@ -102,7 +102,7 @@ private void configureRowHeight() {
/** /**
* Get the commit list this pane renders from. * Get the commit list this pane renders from.
* *
* @return the list the caller must populate. * @return the list the caller must populate.
*/ */
public PlotCommitList getCommitList() { public PlotCommitList getCommitList() {

2
org.eclipse.jgit/src/org/eclipse/jgit/diff/RawText.java
View File

@ -187,4 +187,4 @@ protected int hashLine(final byte[] raw, int ptr, final int end) {
hash = (hash << 5) ^ (raw[ptr] & 0xff); hash = (hash << 5) ^ (raw[ptr] & 0xff);
return hash; return hash;
} }
} }

2
org.eclipse.jgit/src/org/eclipse/jgit/diff/Sequence.java
View File

@ -81,4 +81,4 @@ public interface Sequence {
* @return true if the elements are equal; false if they are not equal. * @return true if the elements are equal; false if they are not equal.
*/ */
public boolean equals(int thisIdx, Sequence other, int otherIdx); public boolean equals(int thisIdx, Sequence other, int otherIdx);
} }

4
org.eclipse.jgit/src/org/eclipse/jgit/errors/CheckoutConflictException.java
View File

@ -61,7 +61,7 @@ public class CheckoutConflictException extends IOException {
public CheckoutConflictException(String file) { public CheckoutConflictException(String file) {
super("Checkout conflict with file: " + file); super("Checkout conflict with file: " + file);
} }
/** /**
* Construct a CheckoutConflictException for the specified set of files * Construct a CheckoutConflictException for the specified set of files
* *
@ -73,7 +73,7 @@ public CheckoutConflictException(String[] files) {
private static String buildList(String[] files) { private static String buildList(String[] files) {
StringBuilder builder = new StringBuilder(); StringBuilder builder = new StringBuilder();
for (String f : files) { for (String f : files) {
builder.append("\n"); builder.append("\n");
builder.append(f); builder.append(f);
} }

4
org.eclipse.jgit/src/org/eclipse/jgit/errors/CompoundException.java
View File

@ -67,7 +67,7 @@ private static String format(final Collection<Throwable> causes) {
/** /**
* Constructs an exception detailing many potential reasons for failure. * Constructs an exception detailing many potential reasons for failure.
* *
* @param why * @param why
* Two or more exceptions that may have been the problem. * Two or more exceptions that may have been the problem.
*/ */
@ -78,7 +78,7 @@ public CompoundException(final Collection<Throwable> why) {
/** /**
* Get the complete list of reasons why this failure happened. * Get the complete list of reasons why this failure happened.
* *
* @return unmodifiable collection of all possible reasons. * @return unmodifiable collection of all possible reasons.
*/ */
public List<Throwable> getAllCauses() { public List<Throwable> getAllCauses() {

2
org.eclipse.jgit/src/org/eclipse/jgit/errors/NotSupportedException.java
View File

@ -64,7 +64,7 @@ public NotSupportedException(final String s) {
/** /**
* Construct a NotSupportedException for some issue JGit cannot yet handle. * Construct a NotSupportedException for some issue JGit cannot yet handle.
* *
* @param s * @param s
* message describing the issue * message describing the issue
* @param why * @param why

4
org.eclipse.jgit/src/org/eclipse/jgit/errors/PackProtocolException.java
View File

@ -84,7 +84,7 @@ public PackProtocolException(final URIish uri, final String s,
/** /**
* Constructs an PackProtocolException with the specified detail message. * Constructs an PackProtocolException with the specified detail message.
* *
* @param s * @param s
* message * message
*/ */
@ -94,7 +94,7 @@ public PackProtocolException(final String s) {
/** /**
* Constructs an PackProtocolException with the specified detail message. * Constructs an PackProtocolException with the specified detail message.
* *
* @param s * @param s
* message * message
* @param cause * @param cause

4
org.eclipse.jgit/src/org/eclipse/jgit/errors/RevisionSyntaxException.java
View File

@ -59,13 +59,13 @@ public class RevisionSyntaxException extends IOException {
/** /**
* Construct a RevisionSyntaxException indicating a syntax problem with a * Construct a RevisionSyntaxException indicating a syntax problem with a
* revision (or object) string. * revision (or object) string.
* *
* @param revstr The problematic revision string * @param revstr The problematic revision string
*/ */
public RevisionSyntaxException(String revstr) { public RevisionSyntaxException(String revstr) {
this.revstr = revstr; this.revstr = revstr;
} }
/** /**
* Construct a RevisionSyntaxException indicating a syntax problem with a * Construct a RevisionSyntaxException indicating a syntax problem with a
* revision (or object) string. * revision (or object) string.

2
org.eclipse.jgit/src/org/eclipse/jgit/errors/StopWalkException.java
View File

@ -46,7 +46,7 @@
/** /**
* Stops the driver loop of walker and finish with current results. * Stops the driver loop of walker and finish with current results.
* *
* @see org.eclipse.jgit.revwalk.filter.RevFilter * @see org.eclipse.jgit.revwalk.filter.RevFilter
*/ */
public class StopWalkException extends RuntimeException { public class StopWalkException extends RuntimeException {

4
org.eclipse.jgit/src/org/eclipse/jgit/errors/TransportException.java
View File

@ -86,7 +86,7 @@ public TransportException(final URIish uri, final String s,
/** /**
* Constructs an TransportException with the specified detail message. * Constructs an TransportException with the specified detail message.
* *
* @param s * @param s
* message * message
*/ */
@ -96,7 +96,7 @@ public TransportException(final String s) {
/** /**
* Constructs an TransportException with the specified detail message. * Constructs an TransportException with the specified detail message.
* *
* @param s * @param s
* message * message
* @param cause * @param cause

24
org.eclipse.jgit/src/org/eclipse/jgit/lib/AnyObjectId.java
View File

@ -71,7 +71,7 @@ public abstract class AnyObjectId implements Comparable {
/** /**
* Compare to object identifier byte sequences for equality. * Compare to object identifier byte sequences for equality.
* *
* @param firstObjectId * @param firstObjectId
* the first identifier to compare. Must not be null. * the first identifier to compare. Must not be null.
* @param secondObjectId * @param secondObjectId
@ -108,7 +108,7 @@ public static boolean equals(final AnyObjectId firstObjectId,
/** /**
* For ObjectIdMap * For ObjectIdMap
* *
* @return a discriminator usable for a fan-out style map * @return a discriminator usable for a fan-out style map
*/ */
public final int getFirstByte() { public final int getFirstByte() {
@ -117,7 +117,7 @@ public final int getFirstByte() {
/** /**
* Compare this ObjectId to another and obtain a sort ordering. * Compare this ObjectId to another and obtain a sort ordering.
* *
* @param other * @param other
* the other id to compare to. Must not be null. * the other id to compare to. Must not be null.
* @return < 0 if this id comes before other; 0 if this id is equal to * @return < 0 if this id comes before other; 0 if this id is equal to
@ -213,7 +213,7 @@ public int hashCode() {
/** /**
* Determine if this ObjectId has exactly the same value as another. * Determine if this ObjectId has exactly the same value as another.
* *
* @param other * @param other
* the other id to compare to. May be null. * the other id to compare to. May be null.
* @return true only if both ObjectIds have identical bits. * @return true only if both ObjectIds have identical bits.
@ -231,7 +231,7 @@ public boolean equals(final Object o) {
/** /**
* Copy this ObjectId to an output writer in raw binary. * Copy this ObjectId to an output writer in raw binary.
* *
* @param w * @param w
* the buffer to copy to. Must be in big endian order. * the buffer to copy to. Must be in big endian order.
*/ */
@ -245,7 +245,7 @@ public void copyRawTo(final ByteBuffer w) {
/** /**
* Copy this ObjectId to a byte array. * Copy this ObjectId to a byte array.
* *
* @param b * @param b
* the buffer to copy to. * the buffer to copy to.
* @param o * @param o
@ -277,7 +277,7 @@ public void copyRawTo(final int[] b, final int o) {
/** /**
* Copy this ObjectId to an output writer in raw binary. * Copy this ObjectId to an output writer in raw binary.
* *
* @param w * @param w
* the stream to write to. * the stream to write to.
* @throws IOException * @throws IOException
@ -301,7 +301,7 @@ private static void writeRawInt(final OutputStream w, int v)
/** /**
* Copy this ObjectId to an output writer in hex format. * Copy this ObjectId to an output writer in hex format.
* *
* @param w * @param w
* the stream to copy to. * the stream to copy to.
* @throws IOException * @throws IOException
@ -336,7 +336,7 @@ private static void formatHexByte(final byte[] dst, final int p, int w) {
/** /**
* Copy this ObjectId to an output writer in hex format. * Copy this ObjectId to an output writer in hex format.
* *
* @param w * @param w
* the stream to copy to. * the stream to copy to.
* @throws IOException * @throws IOException
@ -348,7 +348,7 @@ public void copyTo(final Writer w) throws IOException {
/** /**
* Copy this ObjectId to an output writer in hex format. * Copy this ObjectId to an output writer in hex format.
* *
* @param tmp * @param tmp
* temporary char array to buffer construct into before writing. * temporary char array to buffer construct into before writing.
* Must be at least large enough to hold 2 digits for each byte * Must be at least large enough to hold 2 digits for each byte
@ -469,7 +469,7 @@ public AbbreviatedObjectId abbreviate(final Repository repo, final int len) {
* This method is useful to shed any additional memory that may be tied to * This method is useful to shed any additional memory that may be tied to
* the subclass, yet retain the unique identity of the object id for future * the subclass, yet retain the unique identity of the object id for future
* lookups within maps and repositories. * lookups within maps and repositories.
* *
* @return an immutable copy, using the smallest memory footprint possible. * @return an immutable copy, using the smallest memory footprint possible.
*/ */
public final ObjectId copy() { public final ObjectId copy() {
@ -484,7 +484,7 @@ public final ObjectId copy() {
* See {@link #copy()} if <code>this</code> is a possibly subclassed (but * See {@link #copy()} if <code>this</code> is a possibly subclassed (but
* immutable) identity and the application needs a lightweight identity * immutable) identity and the application needs a lightweight identity
* <i>only</i> reference. * <i>only</i> reference.
* *
* @return an immutable copy. May be <code>this</code> if this is already * @return an immutable copy. May be <code>this</code> if this is already
* an immutable instance. * an immutable instance.
*/ */

8
org.eclipse.jgit/src/org/eclipse/jgit/lib/ByteWindow.java
View File

@ -79,7 +79,7 @@ final boolean contains(final PackFile neededFile, final long neededPos) {
/** /**
* Copy bytes from the window to a caller supplied buffer. * Copy bytes from the window to a caller supplied buffer.
* *
* @param pos * @param pos
* offset within the file to start copying from. * offset within the file to start copying from.
* @param dstbuf * @param dstbuf
@ -100,7 +100,7 @@ final int copy(long pos, byte[] dstbuf, int dstoff, int cnt) {
/** /**
* Copy bytes from the window to a caller supplied buffer. * Copy bytes from the window to a caller supplied buffer.
* *
* @param pos * @param pos
* offset within the window to start copying from. * offset within the window to start copying from.
* @param dstbuf * @param dstbuf
@ -119,7 +119,7 @@ final int copy(long pos, byte[] dstbuf, int dstoff, int cnt) {
/** /**
* Pump bytes into the supplied inflater as input. * Pump bytes into the supplied inflater as input.
* *
* @param pos * @param pos
* offset within the file to start supplying input from. * offset within the file to start supplying input from.
* @param dstbuf * @param dstbuf
@ -148,7 +148,7 @@ final int inflate(long pos, byte[] dstbuf, int dstoff, Inflater inf)
/** /**
* Pump bytes into the supplied inflater as input. * Pump bytes into the supplied inflater as input.
* *
* @param pos * @param pos
* offset within the window to start supplying input from. * offset within the window to start supplying input from.
* @param dstbuf * @param dstbuf

4
org.eclipse.jgit/src/org/eclipse/jgit/lib/Commit.java
View File

@ -67,7 +67,7 @@ public class Commit implements Treeish {
private ObjectId treeId; private ObjectId treeId;
private ObjectId[] parentIds; private ObjectId[] parentIds;
private PersonIdent author; private PersonIdent author;
private PersonIdent committer; private PersonIdent committer;
@ -91,7 +91,7 @@ public Commit(final Repository db) {
objdb = db; objdb = db;
parentIds = EMPTY_OBJECTID_LIST; parentIds = EMPTY_OBJECTID_LIST;
} }
/** /**
* Create a commit associated with these parents and associate it with a * Create a commit associated with these parents and associate it with a
* repository. * repository.

18
org.eclipse.jgit/src/org/eclipse/jgit/lib/Constants.java
View File

@ -123,7 +123,7 @@ public final class Constants {
* Indicates the associated object is a commit. * Indicates the associated object is a commit.
* <p> * <p>
* <b>This constant is fixed and is defined by the Git packfile format.</b> * <b>This constant is fixed and is defined by the Git packfile format.</b>
* *
* @see #TYPE_COMMIT * @see #TYPE_COMMIT
*/ */
public static final int OBJ_COMMIT = 1; public static final int OBJ_COMMIT = 1;
@ -134,7 +134,7 @@ public final class Constants {
* Indicates the associated object is a tree. * Indicates the associated object is a tree.
* <p> * <p>
* <b>This constant is fixed and is defined by the Git packfile format.</b> * <b>This constant is fixed and is defined by the Git packfile format.</b>
* *
* @see #TYPE_BLOB * @see #TYPE_BLOB
*/ */
public static final int OBJ_TREE = 2; public static final int OBJ_TREE = 2;
@ -145,7 +145,7 @@ public final class Constants {
* Indicates the associated object is a blob. * Indicates the associated object is a blob.
* <p> * <p>
* <b>This constant is fixed and is defined by the Git packfile format.</b> * <b>This constant is fixed and is defined by the Git packfile format.</b>
* *
* @see #TYPE_BLOB * @see #TYPE_BLOB
*/ */
public static final int OBJ_BLOB = 3; public static final int OBJ_BLOB = 3;
@ -156,7 +156,7 @@ public final class Constants {
* Indicates the associated object is an annotated tag. * Indicates the associated object is an annotated tag.
* <p> * <p>
* <b>This constant is fixed and is defined by the Git packfile format.</b> * <b>This constant is fixed and is defined by the Git packfile format.</b>
* *
* @see #TYPE_TAG * @see #TYPE_TAG
*/ */
public static final int OBJ_TAG = 4; public static final int OBJ_TAG = 4;
@ -203,7 +203,7 @@ public final class Constants {
* <b>This constant is fixed and is defined by the Git packfile format.</b> * <b>This constant is fixed and is defined by the Git packfile format.</b>
*/ */
public static final byte[] PACK_SIGNATURE = { 'P', 'A', 'C', 'K' }; public static final byte[] PACK_SIGNATURE = { 'P', 'A', 'C', 'K' };
/** Native character encoding for commit messages, file names... */ /** Native character encoding for commit messages, file names... */
public static final String CHARACTER_ENCODING = "UTF-8"; public static final String CHARACTER_ENCODING = "UTF-8";
@ -260,7 +260,7 @@ public final class Constants {
/** /**
* Create a new digest function for objects. * Create a new digest function for objects.
* *
* @return a new digest object. * @return a new digest object.
* @throws RuntimeException * @throws RuntimeException
* this Java virtual machine does not support the required hash * this Java virtual machine does not support the required hash
@ -323,7 +323,7 @@ public static byte[] encodedTypeString(final int typeCode) {
/** /**
* Parse an encoded type string into a type constant. * Parse an encoded type string into a type constant.
* *
* @param id * @param id
* object id this type string came from; may be null if that is * object id this type string came from; may be null if that is
* not known at the time the parse is occurring. * not known at the time the parse is occurring.
@ -398,7 +398,7 @@ public static int decodeTypeString(final AnyObjectId id,
/** /**
* Convert an integer into its decimal representation. * Convert an integer into its decimal representation.
* *
* @param s * @param s
* the integer to convert. * the integer to convert.
* @return a decimal representation of the input integer. The returned array * @return a decimal representation of the input integer. The returned array
@ -410,7 +410,7 @@ public static byte[] encodeASCII(final long s) {
/** /**
* Convert a string to US-ASCII encoding. * Convert a string to US-ASCII encoding.
* *
* @param s * @param s
* the string to convert. Must not contain any characters over * the string to convert. Must not contain any characters over
* 127 (outside of 7-bit ASCII). * 127 (outside of 7-bit ASCII).

2
org.eclipse.jgit/src/org/eclipse/jgit/lib/FileBasedConfig.java
View File

@ -146,4 +146,4 @@ public void save() throws IOException {
public String toString() { public String toString() {
return getClass().getSimpleName() + "[" + getFile().getPath() + "]"; return getClass().getSimpleName() + "[" + getFile().getPath() + "]";
} }
} }

8
org.eclipse.jgit/src/org/eclipse/jgit/lib/FileMode.java
View File

@ -138,7 +138,7 @@ public boolean equals(final int modeBits) {
/** /**
* Convert a set of mode bits into a FileMode enumerated value. * Convert a set of mode bits into a FileMode enumerated value.
* *
* @param bits * @param bits
* the mode bits the caller has somehow obtained. * the mode bits the caller has somehow obtained.
* @return the FileMode instance that represents the given bits. * @return the FileMode instance that represents the given bits.
@ -198,7 +198,7 @@ private FileMode(int mode, final int expType) {
/** /**
* Test a file mode for equality with this {@link FileMode} object. * Test a file mode for equality with this {@link FileMode} object.
* *
* @param modebits * @param modebits
* @return true if the mode bits represent the same mode as this object * @return true if the mode bits represent the same mode as this object
*/ */
@ -212,7 +212,7 @@ private FileMode(int mode, final int expType) {
* indicate octal notation. This method is suitable for generation of a mode * indicate octal notation. This method is suitable for generation of a mode
* string within a GIT tree object. * string within a GIT tree object.
* </p> * </p>
* *
* @param os * @param os
* stream to copy the mode to. * stream to copy the mode to.
* @throws IOException * @throws IOException
@ -233,7 +233,7 @@ public int copyToLength() {
* Get the object type that should appear for this type of mode. * Get the object type that should appear for this type of mode.
* <p> * <p>
* See the object type constants in {@link Constants}. * See the object type constants in {@link Constants}.
* *
* @return one of the well known object type constants. * @return one of the well known object type constants.
*/ */
public int getObjectType() { public int getObjectType() {

22
org.eclipse.jgit/src/org/eclipse/jgit/lib/GitIndex.java
View File

@ -210,7 +210,7 @@ public Entry add(File wd, File f, byte[] content) throws IOException {
* @param f * @param f
* the file whose path shall be removed. * the file whose path shall be removed.
* @return true if such a path was found (and thus removed) * @return true if such a path was found (and thus removed)
* @throws IOException * @throws IOException
*/ */
public boolean remove(File wd, File f) throws IOException { public boolean remove(File wd, File f) throws IOException {
byte[] key = makeKey(wd, f); byte[] key = makeKey(wd, f);
@ -530,13 +530,13 @@ void write(ByteBuffer buf) {
} }
/** /**
* Check if an entry's content is different from the cache, * Check if an entry's content is different from the cache,
* *
* File status information is used and status is same we * File status information is used and status is same we
* consider the file identical to the state in the working * consider the file identical to the state in the working
* directory. Native git uses more stat fields than we * directory. Native git uses more stat fields than we
* have accessible in Java. * have accessible in Java.
* *
* @param wd working directory to compare content with * @param wd working directory to compare content with
* @return true if content is most likely different. * @return true if content is most likely different.
*/ */
@ -545,17 +545,17 @@ public boolean isModified(File wd) {
} }
/** /**
* Check if an entry's content is different from the cache, * Check if an entry's content is different from the cache,
* *
* File status information is used and status is same we * File status information is used and status is same we
* consider the file identical to the state in the working * consider the file identical to the state in the working
* directory. Native git uses more stat fields than we * directory. Native git uses more stat fields than we
* have accessible in Java. * have accessible in Java.
* *
* @param wd working directory to compare content with * @param wd working directory to compare content with
* @param forceContentCheck True if the actual file content * @param forceContentCheck True if the actual file content
* should be checked if modification time differs. * should be checked if modification time differs.
* *
* @return true if content is most likely different. * @return true if content is most likely different.
*/ */
public boolean isModified(File wd, boolean forceContentCheck) { public boolean isModified(File wd, boolean forceContentCheck) {
@ -806,7 +806,7 @@ void readTree(String prefix, Tree t) throws IOException {
} }
} }
} }
/** /**
* Add tree entry to index * Add tree entry to index
* @param te tree entry * @param te tree entry
@ -834,7 +834,7 @@ public void checkout(File wd) throws IOException {
checkoutEntry(wd, e); checkoutEntry(wd, e);
} }
} }
/** /**
* Check out content of the specified index entry * Check out content of the specified index entry
* *
@ -948,7 +948,7 @@ int longestCommonPath(String[] a, String[] b) {
* Small beware: Unaccounted for are unmerged entries. You may want * Small beware: Unaccounted for are unmerged entries. You may want
* to abort if members with stage != 0 are found if you are doing * to abort if members with stage != 0 are found if you are doing
* any updating operations. All stages will be found after one another * any updating operations. All stages will be found after one another
* here later. Currently only one stage per name is returned. * here later. Currently only one stage per name is returned.
* *
* @return The index entries sorted * @return The index entries sorted
*/ */

12
org.eclipse.jgit/src/org/eclipse/jgit/lib/IndexDiff.java
View File

@ -56,7 +56,7 @@
public class IndexDiff { public class IndexDiff {
private GitIndex index; private GitIndex index;
private Tree tree; private Tree tree;
/** /**
* Construct an indexdiff for diffing the workdir against * Construct an indexdiff for diffing the workdir against
* the index. * the index.
@ -80,9 +80,9 @@ public IndexDiff(Tree tree, GitIndex index) {
this.tree = tree; this.tree = tree;
this.index = index; this.index = index;
} }
boolean anyChanges = false; boolean anyChanges = false;
/** /**
* Run the diff operation. Until this is called, all lists will be empty * Run the diff operation. Until this is called, all lists will be empty
* @return if anything is different between index, tree, and workdir * @return if anything is different between index, tree, and workdir
@ -105,7 +105,7 @@ public void visitEntry(TreeEntry treeEntry, Entry indexEntry, File file) {
anyChanges = true; anyChanges = true;
} }
} }
if (indexEntry != null) { if (indexEntry != null) {
if (!file.exists()) { if (!file.exists()) {
missing.add(indexEntry.getName()); missing.add(indexEntry.getName());
@ -119,7 +119,7 @@ public void visitEntry(TreeEntry treeEntry, Entry indexEntry, File file) {
} }
} }
}).walk(); }).walk();
return anyChanges; return anyChanges;
} }
@ -156,7 +156,7 @@ public HashSet<String> getRemoved() {
public HashSet<String> getMissing() { public HashSet<String> getMissing() {
return missing; return missing;
} }
/** /**
* @return list of files on modified on disk relative to the index * @return list of files on modified on disk relative to the index
*/ */

2
org.eclipse.jgit/src/org/eclipse/jgit/lib/IndexTreeVisitor.java
View File

@ -69,7 +69,7 @@ public interface IndexTreeVisitor {
* @throws IOException * @throws IOException
*/ */
public void visitEntry(TreeEntry treeEntry, Entry indexEntry, File file) throws IOException; public void visitEntry(TreeEntry treeEntry, Entry indexEntry, File file) throws IOException;
/** /**
* Visit a blob, and corresponding tree nodes and associated index entry. * Visit a blob, and corresponding tree nodes and associated index entry.
* *

26
org.eclipse.jgit/src/org/eclipse/jgit/lib/IndexTreeWalker.java
View File

@ -75,12 +75,12 @@ public IndexTreeWalker(GitIndex index, Tree tree, File root, IndexTreeVisitor vi
this.root = root; this.root = root;
this.visitor = visitor; this.visitor = visitor;
this.newTree = null; this.newTree = null;
threeTrees = false; threeTrees = false;
indexMembers = index.getMembers(); indexMembers = index.getMembers();
} }
/** /**
* Construct a walker for the index and two trees. * Construct a walker for the index and two trees.
* *
@ -95,15 +95,15 @@ public IndexTreeWalker(GitIndex index, Tree mainTree, Tree newTree, File root, I
this.newTree = newTree; this.newTree = newTree;
this.root = root; this.root = root;
this.visitor = visitor; this.visitor = visitor;
threeTrees = true; threeTrees = true;
indexMembers = index.getMembers(); indexMembers = index.getMembers();
} }
Entry[] indexMembers; Entry[] indexMembers;
int indexCounter = 0; int indexCounter = 0;
/** /**
* Actually walk the index tree * Actually walk the index tree
* *
@ -124,7 +124,7 @@ private void walk(Tree tree, Tree auxTree) throws IOException {
int cmpma = compare(m, a); int cmpma = compare(m, a);
int cmpmi = compare(m, i); int cmpmi = compare(m, i);
int cmpai = compare(a, i); int cmpai = compare(a, i);
TreeEntry pm = cmpma <= 0 && cmpmi <= 0 ? m : null; TreeEntry pm = cmpma <= 0 && cmpmi <= 0 ? m : null;
TreeEntry pa = cmpma >= 0 && cmpai <= 0 ? a : null; TreeEntry pa = cmpma >= 0 && cmpai <= 0 ? a : null;
Entry pi = cmpmi >= 0 && cmpai >= 0 ? i : null; Entry pi = cmpmi >= 0 && cmpai >= 0 ? i : null;
@ -201,7 +201,7 @@ else if (t1 != null || t2 != null)
static boolean lt(TreeEntry h, Entry i) { static boolean lt(TreeEntry h, Entry i) {
return compare(h, i) < 0; return compare(h, i) < 0;
} }
static boolean lt(Entry i, TreeEntry t) { static boolean lt(Entry i, TreeEntry t) {
return compare(t, i) > 0; return compare(t, i) > 0;
} }
@ -209,11 +209,11 @@ static boolean lt(Entry i, TreeEntry t) {
static boolean lt(TreeEntry h, TreeEntry m) { static boolean lt(TreeEntry h, TreeEntry m) {
return compare(h, m) < 0; return compare(h, m) < 0;
} }
static boolean eq(TreeEntry t1, TreeEntry t2) { static boolean eq(TreeEntry t1, TreeEntry t2) {
return compare(t1, t2) == 0; return compare(t1, t2) == 0;
} }
static boolean eq(TreeEntry t1, Entry e) { static boolean eq(TreeEntry t1, Entry e) {
return compare(t1, e) == 0; return compare(t1, e) == 0;
} }
@ -225,9 +225,9 @@ static int compare(TreeEntry t, Entry i) {
return 1; return 1;
if (i == null) if (i == null)
return -1; return -1;
return Tree.compareNames(t.getFullNameUTF8(), i.getNameUTF8(), TreeEntry.lastChar(t), TreeEntry.lastChar(i)); return Tree.compareNames(t.getFullNameUTF8(), i.getNameUTF8(), TreeEntry.lastChar(t), TreeEntry.lastChar(i));
} }
static int compare(TreeEntry t1, TreeEntry t2) { static int compare(TreeEntry t1, TreeEntry t2) {
if (t1 != null && t1.getParent() == null && t2 != null && t2.getParent() == null) if (t1 != null && t1.getParent() == null && t2 != null && t2.getParent() == null)
return 0; return 0;
@ -244,5 +244,5 @@ static int compare(TreeEntry t1, TreeEntry t2) {
return -1; return -1;
return Tree.compareNames(t1.getFullNameUTF8(), t2.getFullNameUTF8(), TreeEntry.lastChar(t1), TreeEntry.lastChar(t2)); return Tree.compareNames(t1.getFullNameUTF8(), t2.getFullNameUTF8(), TreeEntry.lastChar(t1), TreeEntry.lastChar(t2));
} }
} }

4
org.eclipse.jgit/src/org/eclipse/jgit/lib/InflaterCache.java
View File

@ -63,7 +63,7 @@ public class InflaterCache {
* <p> * <p>
* Inflaters obtained through this cache should be returned (if possible) by * Inflaters obtained through this cache should be returned (if possible) by
* {@link #release(Inflater)} to avoid garbage collection and reallocation. * {@link #release(Inflater)} to avoid garbage collection and reallocation.
* *
* @return an available inflater. Never null. * @return an available inflater. Never null.
*/ */
public static Inflater get() { public static Inflater get() {
@ -82,7 +82,7 @@ private synchronized static Inflater getImpl() {
/** /**
* Release an inflater previously obtained from this cache. * Release an inflater previously obtained from this cache.
* *
* @param i * @param i
* the inflater to return. May be null, in which case this method * the inflater to return. May be null, in which case this method
* does nothing. * does nothing.

20
org.eclipse.jgit/src/org/eclipse/jgit/lib/LockFile.java
View File

@ -81,7 +81,7 @@ public class LockFile {
/** /**
* Create a new lock for any file. * Create a new lock for any file.
* *
* @param f * @param f
* the file that will be locked. * the file that will be locked.
*/ */
@ -92,7 +92,7 @@ public LockFile(final File f) {
/** /**
* Try to establish the lock. * Try to establish the lock.
* *
* @return true if the lock is now held by the caller; false if it is held * @return true if the lock is now held by the caller; false if it is held
* by someone else. * by someone else.
* @throws IOException * @throws IOException
@ -132,7 +132,7 @@ public boolean lock() throws IOException {
/** /**
* Try to establish the lock for appending. * Try to establish the lock for appending.
* *
* @return true if the lock is now held by the caller; false if it is held * @return true if the lock is now held by the caller; false if it is held
* by someone else. * by someone else.
* @throws IOException * @throws IOException
@ -155,7 +155,7 @@ public boolean lockForAppend() throws IOException {
* <p> * <p>
* This method does nothing if the current file does not exist, or exists * This method does nothing if the current file does not exist, or exists
* but is empty. * but is empty.
* *
* @throws IOException * @throws IOException
* the temporary file could not be written, or a read error * the temporary file could not be written, or a read error
* occurred while reading from the current file. The lock is * occurred while reading from the current file. The lock is
@ -195,7 +195,7 @@ public void copyCurrentContent() throws IOException {
/** /**
* Write an ObjectId and LF to the temporary file. * Write an ObjectId and LF to the temporary file.
* *
* @param id * @param id
* the id to store in the file. The id will be written in hex, * the id to store in the file. The id will be written in hex,
* followed by a sole LF. * followed by a sole LF.
@ -231,7 +231,7 @@ public void write(final ObjectId id) throws IOException {
/** /**
* Write arbitrary data to the temporary file. * Write arbitrary data to the temporary file.
* *
* @param content * @param content
* the bytes to store in the temporary file. No additional bytes * the bytes to store in the temporary file. No additional bytes
* are added, so if the file must end with an LF it must appear * are added, so if the file must end with an LF it must appear
@ -269,7 +269,7 @@ public void write(final byte[] content) throws IOException {
* The stream may only be accessed once, and only after {@link #lock()} has * The stream may only be accessed once, and only after {@link #lock()} has
* been successfully invoked and returned true. Callers must close the * been successfully invoked and returned true. Callers must close the
* stream prior to calling {@link #commit()} to commit the change. * stream prior to calling {@link #commit()} to commit the change.
* *
* @return a stream to write to the new file. The stream is unbuffered. * @return a stream to write to the new file. The stream is unbuffered.
*/ */
public OutputStream getOutputStream() { public OutputStream getOutputStream() {
@ -326,7 +326,7 @@ private void requireLock() {
/** /**
* Request that {@link #commit()} remember modification time. * Request that {@link #commit()} remember modification time.
* *
* @param on * @param on
* true if the commit method must remember the modification time. * true if the commit method must remember the modification time.
*/ */
@ -338,7 +338,7 @@ public void setNeedStatInformation(final boolean on) {
* Commit this change and release the lock. * Commit this change and release the lock.
* <p> * <p>
* If this method fails (returns false) the lock is still released. * If this method fails (returns false) the lock is still released.
* *
* @return true if the commit was successful and the file contains the new * @return true if the commit was successful and the file contains the new
* data; false if the commit failed and the file remains with the * data; false if the commit failed and the file remains with the
* old data. * old data.
@ -368,7 +368,7 @@ private void saveStatInformation() {
/** /**
* Get the modification time of the output file when it was committed. * Get the modification time of the output file when it was committed.
* *
* @return modification time of the lock file right before we committed it. * @return modification time of the lock file right before we committed it.
*/ */
public long getCommitLastModified() { public long getCommitLastModified() {

16
org.eclipse.jgit/src/org/eclipse/jgit/lib/MutableObjectId.java
View File

@ -64,7 +64,7 @@ public MutableObjectId() {
/** /**
* Copying constructor. * Copying constructor.
* *
* @param src * @param src
* original entry, to copy id from * original entry, to copy id from
*/ */
@ -87,7 +87,7 @@ public void clear() {
/** /**
* Convert an ObjectId from raw binary representation. * Convert an ObjectId from raw binary representation.
* *
* @param bs * @param bs
* the raw byte buffer to read from. At least 20 bytes must be * the raw byte buffer to read from. At least 20 bytes must be
* available within this byte array. * available within this byte array.
@ -98,7 +98,7 @@ public void fromRaw(final byte[] bs) {
/** /**
* Convert an ObjectId from raw binary representation. * Convert an ObjectId from raw binary representation.
* *
* @param bs * @param bs
* the raw byte buffer to read from. At least 20 bytes after p * the raw byte buffer to read from. At least 20 bytes after p
* must be available within this byte array. * must be available within this byte array.
@ -115,7 +115,7 @@ public void fromRaw(final byte[] bs, final int p) {
/** /**
* Convert an ObjectId from binary representation expressed in integers. * Convert an ObjectId from binary representation expressed in integers.
* *
* @param ints * @param ints
* the raw int buffer to read from. At least 5 integers must be * the raw int buffer to read from. At least 5 integers must be
* available within this integers array. * available within this integers array.
@ -126,13 +126,13 @@ public void fromRaw(final int[] ints) {
/** /**
* Convert an ObjectId from binary representation expressed in integers. * Convert an ObjectId from binary representation expressed in integers.
* *
* @param ints * @param ints
* the raw int buffer to read from. At least 5 integers after p * the raw int buffer to read from. At least 5 integers after p
* must be available within this integers array. * must be available within this integers array.
* @param p * @param p
* position to read the first integer of data from. * position to read the first integer of data from.
* *
*/ */
public void fromRaw(final int[] ints, final int p) { public void fromRaw(final int[] ints, final int p) {
w1 = ints[p]; w1 = ints[p];
@ -144,7 +144,7 @@ public void fromRaw(final int[] ints, final int p) {
/** /**
* Convert an ObjectId from hex characters (US-ASCII). * Convert an ObjectId from hex characters (US-ASCII).
* *
* @param buf * @param buf
* the US-ASCII buffer to read from. At least 40 bytes after * the US-ASCII buffer to read from. At least 40 bytes after
* offset must be available within this byte array. * offset must be available within this byte array.
@ -157,7 +157,7 @@ public void fromString(final byte[] buf, final int offset) {
/** /**
* Convert an ObjectId from hex characters. * Convert an ObjectId from hex characters.
* *
* @param str * @param str
* the string to read from. Must be 40 characters long. * the string to read from. Must be 40 characters long.
*/ */

18
org.eclipse.jgit/src/org/eclipse/jgit/lib/ObjectId.java
View File

@ -63,7 +63,7 @@ public class ObjectId extends AnyObjectId {
/** /**
* Get the special all-null ObjectId. * Get the special all-null ObjectId.
* *
* @return the all-null ObjectId, often used to stand-in for no object. * @return the all-null ObjectId, often used to stand-in for no object.
*/ */
public static final ObjectId zeroId() { public static final ObjectId zeroId() {
@ -74,7 +74,7 @@ public static final ObjectId zeroId() {
* Test a string of characters to verify it is a hex format. * Test a string of characters to verify it is a hex format.
* <p> * <p>
* If true the string can be parsed with {@link #fromString(String)}. * If true the string can be parsed with {@link #fromString(String)}.
* *
* @param id * @param id
* the string to test. * the string to test.
* @return true if the string can converted into an ObjectId. * @return true if the string can converted into an ObjectId.
@ -94,7 +94,7 @@ public static final boolean isId(final String id) {
/** /**
* Convert an ObjectId into a hex string representation. * Convert an ObjectId into a hex string representation.
* *
* @param i * @param i
* the id to convert. May be null. * the id to convert. May be null.
* @return the hex string conversion of this id's content. * @return the hex string conversion of this id's content.
@ -105,7 +105,7 @@ public static final String toString(final ObjectId i) {
/** /**
* Compare to object identifier byte sequences for equality. * Compare to object identifier byte sequences for equality.
* *
* @param firstBuffer * @param firstBuffer
* the first buffer to compare against. Must have at least 20 * the first buffer to compare against. Must have at least 20
* bytes from position ai through the end of the buffer. * bytes from position ai through the end of the buffer.
@ -144,7 +144,7 @@ public static boolean equals(final byte[] firstBuffer, final int fi,
/** /**
* Convert an ObjectId from raw binary representation. * Convert an ObjectId from raw binary representation.
* *
* @param bs * @param bs
* the raw byte buffer to read from. At least 20 bytes must be * the raw byte buffer to read from. At least 20 bytes must be
* available within this byte array. * available within this byte array.
@ -156,7 +156,7 @@ public static final ObjectId fromRaw(final byte[] bs) {
/** /**
* Convert an ObjectId from raw binary representation. * Convert an ObjectId from raw binary representation.
* *
* @param bs * @param bs
* the raw byte buffer to read from. At least 20 bytes after p * the raw byte buffer to read from. At least 20 bytes after p
* must be available within this byte array. * must be available within this byte array.
@ -201,7 +201,7 @@ public static final ObjectId fromRaw(final int[] is, final int p) {
/** /**
* Convert an ObjectId from hex characters (US-ASCII). * Convert an ObjectId from hex characters (US-ASCII).
* *
* @param buf * @param buf
* the US-ASCII buffer to read from. At least 40 bytes after * the US-ASCII buffer to read from. At least 40 bytes after
* offset must be available within this byte array. * offset must be available within this byte array.
@ -215,7 +215,7 @@ public static final ObjectId fromString(final byte[] buf, final int offset) {
/** /**
* Convert an ObjectId from hex characters. * Convert an ObjectId from hex characters.
* *
* @param str * @param str
* the string to read from. Must be 40 characters long. * the string to read from. Must be 40 characters long.
* @return the converted object id. * @return the converted object id.
@ -254,7 +254,7 @@ private static final ObjectId fromHexString(final byte[] bs, int p) {
* This constructor is mostly useful for subclasses who want to extend an * This constructor is mostly useful for subclasses who want to extend an
* ObjectId with more properties, but initialize from an existing ObjectId * ObjectId with more properties, but initialize from an existing ObjectId
* instance acquired by other means. * instance acquired by other means.
* *
* @param src * @param src
* another already parsed ObjectId to copy the value out of. * another already parsed ObjectId to copy the value out of.
*/ */

6
org.eclipse.jgit/src/org/eclipse/jgit/lib/ObjectIdSubclassMap.java
View File

@ -57,7 +57,7 @@
* not reference equality and not <code>.equals(Object)</code> equality. This * not reference equality and not <code>.equals(Object)</code> equality. This
* allows subclasses to override <code>equals</code> to supply their own * allows subclasses to override <code>equals</code> to supply their own
* extended semantics. * extended semantics.
* *
* @param <V> * @param <V>
* type of subclass of ObjectId that will be stored in the map. * type of subclass of ObjectId that will be stored in the map.
*/ */
@ -79,7 +79,7 @@ public void clear() {
/** /**
* Lookup an existing mapping. * Lookup an existing mapping.
* *
* @param toFind * @param toFind
* the object identifier to find. * the object identifier to find.
* @return the instance mapped to toFind, or null if no mapping exists. * @return the instance mapped to toFind, or null if no mapping exists.
@ -103,7 +103,7 @@ public V get(final AnyObjectId toFind) {
* An existing mapping for <b>must not</b> be in this map. Callers must * An existing mapping for <b>must not</b> be in this map. Callers must
* first call {@link #get(AnyObjectId)} to verify there is no current * first call {@link #get(AnyObjectId)} to verify there is no current
* mapping prior to adding a new mapping. * mapping prior to adding a new mapping.
* *
* @param newValue * @param newValue
* the object to store. * the object to store.
* @param * @param

4
org.eclipse.jgit/src/org/eclipse/jgit/lib/ObjectLoader.java
View File

@ -68,7 +68,7 @@ public abstract class ObjectLoader {
* <p> * <p>
* Unlike {@link #getCachedBytes()} this method returns an array that might * Unlike {@link #getCachedBytes()} this method returns an array that might
* be modified by the caller. * be modified by the caller.
* *
* @return the bytes of this object. * @return the bytes of this object.
*/ */
public final byte[] getBytes() { public final byte[] getBytes() {
@ -85,7 +85,7 @@ public final byte[] getBytes() {
* saving on data copies between the internal cache and higher level code. * saving on data copies between the internal cache and higher level code.
* Callers who receive this reference <b>must not</b> modify its contents. * Callers who receive this reference <b>must not</b> modify its contents.
* Changes (if made) will affect the cache but not the repository itself. * Changes (if made) will affect the cache but not the repository itself.
* *
* @return the cached bytes of this object. Do not modify it. * @return the cached bytes of this object. Do not modify it.
*/ */
public abstract byte[] getCachedBytes(); public abstract byte[] getCachedBytes();

12
org.eclipse.jgit/src/org/eclipse/jgit/lib/PackFile.java
View File

@ -105,7 +105,7 @@ public int compare(final PackFile a, final PackFile b) {
/** /**
* Construct a reader for an existing, pre-indexed packfile. * Construct a reader for an existing, pre-indexed packfile.
* *
* @param idxFile * @param idxFile
* path of the <code>.idx</code> file listing the contents. * path of the <code>.idx</code> file listing the contents.
* @param packFile * @param packFile
@ -161,7 +161,7 @@ public File getPackFile() {
* For performance reasons only the index file is searched; the main pack * For performance reasons only the index file is searched; the main pack
* content is ignored entirely. * content is ignored entirely.
* </p> * </p>
* *
* @param id * @param id
* the object to look for. Must not be null. * the object to look for. Must not be null.
* @return true if the object is in this pack; false otherwise. * @return true if the object is in this pack; false otherwise.
@ -174,7 +174,7 @@ public boolean hasObject(final AnyObjectId id) throws IOException {
/** /**
* Get an object from this pack. * Get an object from this pack.
* *
* @param curs * @param curs
* temporary working space associated with the calling thread. * temporary working space associated with the calling thread.
* @param id * @param id
@ -209,9 +209,9 @@ public void close() {
* <p> * <p>
* Iterator returns objects in SHA-1 lexicographical order. * Iterator returns objects in SHA-1 lexicographical order.
* </p> * </p>
* *
* @return iterator over entries of associated pack index * @return iterator over entries of associated pack index
* *
* @see PackIndex#iterator() * @see PackIndex#iterator()
*/ */
public Iterator<PackIndex.MutableEntry> iterator() { public Iterator<PackIndex.MutableEntry> iterator() {
@ -225,7 +225,7 @@ public Iterator<PackIndex.MutableEntry> iterator() {
/** /**
* Obtain the total number of objects available in this pack. This method * Obtain the total number of objects available in this pack. This method
* relies on pack index, giving number of effectively available objects. * relies on pack index, giving number of effectively available objects.
* *
* @return number of objects in index of this pack, likewise in this pack * @return number of objects in index of this pack, likewise in this pack
* @throws IOException * @throws IOException
* the index file cannot be loaded into memory. * the index file cannot be loaded into memory.

14
org.eclipse.jgit/src/org/eclipse/jgit/lib/PackIndex.java
View File

@ -70,7 +70,7 @@ public abstract class PackIndex implements Iterable<PackIndex.MutableEntry> {
* implementation for that format will be constructed and returned to the * implementation for that format will be constructed and returned to the
* caller. The file may or may not be held open by the returned instance. * caller. The file may or may not be held open by the returned instance.
* </p> * </p>
* *
* @param idxFile * @param idxFile
* existing pack .idx to read. * existing pack .idx to read.
* @return access implementation for the requested file. * @return access implementation for the requested file.
@ -123,7 +123,7 @@ private static boolean isTOC(final byte[] h) {
/** /**
* Determine if an object is contained within the pack file. * Determine if an object is contained within the pack file.
* *
* @param id * @param id
* the object to look for. Must not be null. * the object to look for. Must not be null.
* @return true if the object is listed in this index; false otherwise. * @return true if the object is listed in this index; false otherwise.
@ -140,14 +140,14 @@ public boolean hasObject(final AnyObjectId id) {
* <p> * <p>
* Iterator returns objects in SHA-1 lexicographical order. * Iterator returns objects in SHA-1 lexicographical order.
* </p> * </p>
* *
* @return iterator over pack index entries * @return iterator over pack index entries
*/ */
public abstract Iterator<MutableEntry> iterator(); public abstract Iterator<MutableEntry> iterator();
/** /**
* Obtain the total number of objects described by this index. * Obtain the total number of objects described by this index.
* *
* @return number of objects in this index, and likewise in the associated * @return number of objects in this index, and likewise in the associated
* pack that this index was generated from. * pack that this index was generated from.
*/ */
@ -212,7 +212,7 @@ final ObjectId getObjectId(final int nthPosition) {
/** /**
* Locate the file offset position for the requested object. * Locate the file offset position for the requested object.
* *
* @param objId * @param objId
* name of the object to locate within the pack. * name of the object to locate within the pack.
* @return offset of the object's header and compressed content; -1 if the * @return offset of the object's header and compressed content; -1 if the
@ -246,7 +246,7 @@ abstract long findCRC32(AnyObjectId objId) throws MissingObjectException,
/** /**
* Represent mutable entry of pack index consisting of object id and offset * Represent mutable entry of pack index consisting of object id and offset
* in pack (both mutable). * in pack (both mutable).
* *
*/ */
public static class MutableEntry { public static class MutableEntry {
final MutableObjectId idBuffer = new MutableObjectId(); final MutableObjectId idBuffer = new MutableObjectId();
@ -255,7 +255,7 @@ public static class MutableEntry {
/** /**
* Returns offset for this index object entry * Returns offset for this index object entry
* *
* @return offset of this object in a pack file * @return offset of this object in a pack file
*/ */
public long getOffset() { public long getOffset() {

22
org.eclipse.jgit/src/org/eclipse/jgit/lib/PersonIdent.java
View File

@ -54,7 +54,7 @@
/** /**
* A combination of a person identity and time in Git. * A combination of a person identity and time in Git.
* *
* Git combines Name + email + time + time zone to specify who wrote or * Git combines Name + email + time + time zone to specify who wrote or
* committed something. * committed something.
*/ */
@ -71,7 +71,7 @@ public class PersonIdent {
* Creates new PersonIdent from config info in repository, with current time. * Creates new PersonIdent from config info in repository, with current time.
* This new PersonIdent gets the info from the default committer as available * This new PersonIdent gets the info from the default committer as available
* from the configuration. * from the configuration.
* *
* @param repo * @param repo
*/ */
public PersonIdent(final Repository repo) { public PersonIdent(final Repository repo) {
@ -84,7 +84,7 @@ public PersonIdent(final Repository repo) {
/** /**
* Copy a {@link PersonIdent}. * Copy a {@link PersonIdent}.
* *
* @param pi * @param pi
* Original {@link PersonIdent} * Original {@link PersonIdent}
*/ */
@ -94,7 +94,7 @@ public PersonIdent(final PersonIdent pi) {
/** /**
* Construct a new {@link PersonIdent} with current time. * Construct a new {@link PersonIdent} with current time.
* *
* @param aName * @param aName
* @param aEmailAddress * @param aEmailAddress
*/ */
@ -104,7 +104,7 @@ public PersonIdent(final String aName, final String aEmailAddress) {
/** /**
* Copy a PersonIdent, but alter the clone's time stamp * Copy a PersonIdent, but alter the clone's time stamp
* *
* @param pi * @param pi
* original {@link PersonIdent} * original {@link PersonIdent}
* @param when * @param when
@ -118,7 +118,7 @@ public PersonIdent(final PersonIdent pi, final Date when, final TimeZone tz) {
/** /**
* Copy a {@link PersonIdent}, but alter the clone's time stamp * Copy a {@link PersonIdent}, but alter the clone's time stamp
* *
* @param pi * @param pi
* original {@link PersonIdent} * original {@link PersonIdent}
* @param aWhen * @param aWhen
@ -133,7 +133,7 @@ public PersonIdent(final PersonIdent pi, final Date aWhen) {
/** /**
* Construct a PersonIdent from simple data * Construct a PersonIdent from simple data
* *
* @param aName * @param aName
* @param aEmailAddress * @param aEmailAddress
* @param aWhen * @param aWhen
@ -151,7 +151,7 @@ public PersonIdent(final String aName, final String aEmailAddress,
/** /**
* Construct a {@link PersonIdent} * Construct a {@link PersonIdent}
* *
* @param aName * @param aName
* @param aEmailAddress * @param aEmailAddress
* @param aWhen * @param aWhen
@ -169,7 +169,7 @@ public PersonIdent(final String aName, final String aEmailAddress,
/** /**
* Copy a PersonIdent, but alter the clone's time stamp * Copy a PersonIdent, but alter the clone's time stamp
* *
* @param pi * @param pi
* original {@link PersonIdent} * original {@link PersonIdent}
* @param aWhen * @param aWhen
@ -187,7 +187,7 @@ public PersonIdent(final PersonIdent pi, final long aWhen, final int aTZ) {
/** /**
* Construct a PersonIdent from a string with full name, email, time time * Construct a PersonIdent from a string with full name, email, time time
* zone string. The input string must be valid. * zone string. The input string must be valid.
* *
* @param in * @param in
* a Git internal format author/committer string. * a Git internal format author/committer string.
*/ */
@ -278,7 +278,7 @@ && getEmailAddress().equals(p.getEmailAddress())
/** /**
* Format for Git storage. * Format for Git storage.
* *
* @return a string in the git author format * @return a string in the git author format
*/ */
public String toExternalString() { public String toExternalString() {

8
org.eclipse.jgit/src/org/eclipse/jgit/lib/ProgressMonitor.java
View File

@ -53,7 +53,7 @@ public interface ProgressMonitor {
* Advise the monitor of the total number of subtasks. * Advise the monitor of the total number of subtasks.
* <p> * <p>
* This should be invoked at most once per progress monitor interface. * This should be invoked at most once per progress monitor interface.
* *
* @param totalTasks * @param totalTasks
* the total number of tasks the caller will need to complete * the total number of tasks the caller will need to complete
* their processing. * their processing.
@ -62,7 +62,7 @@ public interface ProgressMonitor {
/** /**
* Begin processing a single task. * Begin processing a single task.
* *
* @param title * @param title
* title to describe the task. Callers should publish these as * title to describe the task. Callers should publish these as
* stable string constants that implementations could match * stable string constants that implementations could match
@ -79,7 +79,7 @@ public interface ProgressMonitor {
* This is an incremental update; if invoked once per work unit the correct * This is an incremental update; if invoked once per work unit the correct
* value for our argument is <code>1</code>, to indicate a single unit of * value for our argument is <code>1</code>, to indicate a single unit of
* work has been finished by the caller. * work has been finished by the caller.
* *
* @param completed * @param completed
* the number of work units completed since the last call. * the number of work units completed since the last call.
*/ */
@ -90,7 +90,7 @@ public interface ProgressMonitor {
/** /**
* Check for user task cancellation. * Check for user task cancellation.
* *
* @return true if the user asked the process to stop working. * @return true if the user asked the process to stop working.
*/ */
boolean isCancelled(); boolean isCancelled();

14
org.eclipse.jgit/src/org/eclipse/jgit/lib/Ref.java
View File

@ -136,7 +136,7 @@ public boolean isPacked() {
/** /**
* Create a new ref pairing. * Create a new ref pairing.
* *
* @param st * @param st
* method used to store this ref. * method used to store this ref.
* @param origName * @param origName
@ -153,7 +153,7 @@ public Ref(final Storage st, final String origName, final String refName, final
/** /**
* Create a new ref pairing. * Create a new ref pairing.
* *
* @param st * @param st
* method used to store this ref. * method used to store this ref.
* @param refName * @param refName
@ -168,7 +168,7 @@ public Ref(final Storage st, final String refName, final ObjectId id) {
/** /**
* Create a new ref pairing. * Create a new ref pairing.
* *
* @param st * @param st
* method used to store this ref. * method used to store this ref.
* @param origName * @param origName
@ -196,7 +196,7 @@ public Ref(final Storage st, final String origName, final String refName, final
/** /**
* Create a new ref pairing. * Create a new ref pairing.
* *
* @param st * @param st
* method used to store this ref. * method used to store this ref.
* @param refName * @param refName
@ -217,7 +217,7 @@ public Ref(final Storage st, final String refName, final ObjectId id,
/** /**
* What this ref is called within the repository. * What this ref is called within the repository.
* *
* @return name of this ref. * @return name of this ref.
*/ */
public String getName() { public String getName() {
@ -233,7 +233,7 @@ public String getOrigName() {
/** /**
* Cached value of this ref. * Cached value of this ref.
* *
* @return the value of this ref at the last time we read it. * @return the value of this ref at the last time we read it.
*/ */
public ObjectId getObjectId() { public ObjectId getObjectId() {
@ -242,7 +242,7 @@ public ObjectId getObjectId() {
/** /**
* Cached value of <code>ref^{}</code> (the ref peeled to commit). * Cached value of <code>ref^{}</code> (the ref peeled to commit).
* *
* @return if this ref is an annotated tag the id of the commit (or tree or * @return if this ref is an annotated tag the id of the commit (or tree or
* blob) that the annotated tag refers to; null if this ref does not * blob) that the annotated tag refers to; null if this ref does not
* refer to an annotated tag. * refer to an annotated tag.

4
org.eclipse.jgit/src/org/eclipse/jgit/lib/RefComparator.java
View File

@ -66,7 +66,7 @@ public int compare(final Ref o1, final Ref o2) {
/** /**
* Sorts the collection of refs, returning a new collection. * Sorts the collection of refs, returning a new collection.
* *
* @param refs * @param refs
* collection to be sorted * collection to be sorted
* @return sorted collection of refs * @return sorted collection of refs
@ -76,4 +76,4 @@ public static Collection<Ref> sort(final Collection<Ref> refs) {
Collections.sort(r, INSTANCE); Collections.sort(r, INSTANCE);
return r; return r;
} }
} }

6
org.eclipse.jgit/src/org/eclipse/jgit/lib/RefDatabase.java
View File

@ -126,7 +126,7 @@ ObjectId idOf(final String name) throws IOException {
/** /**
* Create a command to update, create or delete a ref in this repository. * Create a command to update, create or delete a ref in this repository.
* *
* @param name * @param name
* name of the ref the caller wants to modify. * name of the ref the caller wants to modify.
* @return an update command. The caller must finish populating this command * @return an update command. The caller must finish populating this command
@ -172,7 +172,7 @@ RefRename newRename(String fromRef, String toRef) throws IOException {
/** /**
* Writes a symref (e.g. HEAD) to disk * Writes a symref (e.g. HEAD) to disk
* *
* @param name * @param name
* symref name * symref name
* @param target * @param target
@ -382,7 +382,7 @@ private synchronized Ref readRefBasic(final String origName,
return new Ref(Ref.Storage.LOOSE, origName, target, null); return new Ref(Ref.Storage.LOOSE, origName, target, null);
if (!origName.equals(r.getName())) if (!origName.equals(r.getName()))
r = new Ref(Ref.Storage.LOOSE_PACKED, origName, r.getName(), r.getObjectId(), r.getPeeledObjectId(), true); r = new Ref(Ref.Storage.LOOSE_PACKED, origName, r.getName(), r.getObjectId(), r.getPeeledObjectId(), true);
return r; return r;
} }
setModified(); setModified();

4
org.eclipse.jgit/src/org/eclipse/jgit/lib/RefLogWriter.java
View File

@ -53,7 +53,7 @@
/** /**
* Utility class to work with reflog files * Utility class to work with reflog files
* *
* @author Dave Watson * @author Dave Watson
*/ */
public class RefLogWriter { public class RefLogWriter {
@ -137,7 +137,7 @@ private static void appendOneRecord(final ObjectId oldId,
/** /**
* Writes reflog entry for ref specified by refName * Writes reflog entry for ref specified by refName
* *
* @param repo * @param repo
* repository to use * repository to use
* @param oldCommit * @param oldCommit

2
org.eclipse.jgit/src/org/eclipse/jgit/lib/RefRename.java
View File

@ -172,4 +172,4 @@ PersonIdent getRefLogIdent() {
String getToName() { String getToName() {
return newToUpdate.getName(); return newToUpdate.getName();
} }
} }

32
org.eclipse.jgit/src/org/eclipse/jgit/lib/RefUpdate.java
View File

@ -189,7 +189,7 @@ public Repository getRepository() {
/** /**
* Get the name of the ref this update will operate on. * Get the name of the ref this update will operate on.
* *
* @return name of underlying ref. * @return name of underlying ref.
*/ */
public String getName() { public String getName() {
@ -207,7 +207,7 @@ public String getOrigName() {
/** /**
* Get the new value the ref will be (or was) updated to. * Get the new value the ref will be (or was) updated to.
* *
* @return new value. Null if the caller has not configured it. * @return new value. Null if the caller has not configured it.
*/ */
public ObjectId getNewObjectId() { public ObjectId getNewObjectId() {
@ -216,7 +216,7 @@ public ObjectId getNewObjectId() {
/** /**
* Set the new value the ref will update to. * Set the new value the ref will update to.
* *
* @param id * @param id
* the new value. * the new value.
*/ */
@ -247,7 +247,7 @@ public void setExpectedOldObjectId(final AnyObjectId id) {
/** /**
* Check if this update wants to forcefully change the ref. * Check if this update wants to forcefully change the ref.
* *
* @return true if this update should ignore merge tests. * @return true if this update should ignore merge tests.
*/ */
public boolean isForceUpdate() { public boolean isForceUpdate() {
@ -256,7 +256,7 @@ public boolean isForceUpdate() {
/** /**
* Set if this update wants to forcefully change the ref. * Set if this update wants to forcefully change the ref.
* *
* @param b * @param b
* true if this update should ignore merge tests. * true if this update should ignore merge tests.
*/ */
@ -287,7 +287,7 @@ public void setRefLogIdent(final PersonIdent pi) {
/** /**
* Get the message to include in the reflog. * Get the message to include in the reflog.
* *
* @return message the caller wants to include in the reflog; null if the * @return message the caller wants to include in the reflog; null if the
* update should not be logged. * update should not be logged.
*/ */
@ -297,7 +297,7 @@ public String getRefLogMessage() {
/** /**
* Set the message to include in the reflog. * Set the message to include in the reflog.
* *
* @param msg * @param msg
* the message to describe this change. It may be null * the message to describe this change. It may be null
* if appendStatus is null in order not to append to the reflog * if appendStatus is null in order not to append to the reflog
@ -331,7 +331,7 @@ public void disableRefLog() {
* populated with the value of the ref before the lock is taken, but the old * populated with the value of the ref before the lock is taken, but the old
* value may change if someone else modified the ref between the time we * value may change if someone else modified the ref between the time we
* last read it and when the ref was locked for update. * last read it and when the ref was locked for update.
* *
* @return the value of the ref prior to the update being attempted; null if * @return the value of the ref prior to the update being attempted; null if
* the updated has not been attempted yet. * the updated has not been attempted yet.
*/ */
@ -343,7 +343,7 @@ public ObjectId getOldObjectId() {
* Get the status of this update. * Get the status of this update.
* <p> * <p>
* The same value that was previously returned from an update method. * The same value that was previously returned from an update method.
* *
* @return the status of the update. * @return the status of the update.
*/ */
public Result getResult() { public Result getResult() {
@ -360,7 +360,7 @@ private void requireCanDoUpdate() {
* <p> * <p>
* This is just a convenient helper for setting the force flag, and as such * This is just a convenient helper for setting the force flag, and as such
* the merge test is performed. * the merge test is performed.
* *
* @return the result status of the update. * @return the result status of the update.
* @throws IOException * @throws IOException
* an unexpected IO error occurred while writing changes. * an unexpected IO error occurred while writing changes.
@ -376,11 +376,11 @@ public Result forceUpdate() throws IOException {
* Merge test will be performed according to {@link #isForceUpdate()}. * Merge test will be performed according to {@link #isForceUpdate()}.
* <p> * <p>
* This is the same as: * This is the same as:
* *
* <pre> * <pre>
* return update(new RevWalk(repository)); * return update(new RevWalk(repository));
* </pre> * </pre>
* *
* @return the result status of the update. * @return the result status of the update.
* @throws IOException * @throws IOException
* an unexpected IO error occurred while writing changes. * an unexpected IO error occurred while writing changes.
@ -393,7 +393,7 @@ public Result update() throws IOException {
* Gracefully update the ref to the new value. * Gracefully update the ref to the new value.
* <p> * <p>
* Merge test will be performed according to {@link #isForceUpdate()}. * Merge test will be performed according to {@link #isForceUpdate()}.
* *
* @param walk * @param walk
* a RevWalk instance this update command can borrow to perform * a RevWalk instance this update command can borrow to perform
* the merge test. The walk will be reset to perform the test. * the merge test. The walk will be reset to perform the test.
@ -415,11 +415,11 @@ public Result update(final RevWalk walk) throws IOException {
* Delete the ref. * Delete the ref.
* <p> * <p>
* This is the same as: * This is the same as:
* *
* <pre> * <pre>
* return delete(new RevWalk(repository)); * return delete(new RevWalk(repository));
* </pre> * </pre>
* *
* @return the result status of the delete. * @return the result status of the delete.
* @throws IOException * @throws IOException
*/ */
@ -429,7 +429,7 @@ public Result delete() throws IOException {
/** /**
* Delete the ref. * Delete the ref.
* *
* @param walk * @param walk
* a RevWalk instance this delete command can borrow to perform * a RevWalk instance this delete command can borrow to perform
* the merge test. The walk will be reset to perform the test. * the merge test. The walk will be reset to perform the test.

10
org.eclipse.jgit/src/org/eclipse/jgit/lib/RefWriter.java
View File

@ -53,7 +53,7 @@
/** /**
* Writes out refs to the {@link Constants#INFO_REFS} and * Writes out refs to the {@link Constants#INFO_REFS} and
* {@link Constants#PACKED_REFS} files. * {@link Constants#PACKED_REFS} files.
* *
* This class is abstract as the writing of the files must be handled by the * This class is abstract as the writing of the files must be handled by the
* caller. This is because it is used by transport classes as well. * caller. This is because it is used by transport classes as well.
*/ */
@ -75,8 +75,8 @@ public RefWriter(Collection<Ref> refs) {
* <p> * <p>
* This method rebuilds the contents of the {@link Constants#INFO_REFS} file * This method rebuilds the contents of the {@link Constants#INFO_REFS} file
* to match the passed list of references. * to match the passed list of references.
* *
* *
* @throws IOException * @throws IOException
* writing is not supported, or attempting to write the file * writing is not supported, or attempting to write the file
* failed, possibly due to permissions or remote disk full, etc. * failed, possibly due to permissions or remote disk full, etc.
@ -114,7 +114,7 @@ public void writeInfoRefs() throws IOException {
* This method rebuilds the contents of the {@link Constants#PACKED_REFS} * This method rebuilds the contents of the {@link Constants#PACKED_REFS}
* file to match the passed list of references, including only those refs * file to match the passed list of references, including only those refs
* that have a storage type of {@link Ref.Storage#PACKED}. * that have a storage type of {@link Ref.Storage#PACKED}.
* *
* @throws IOException * @throws IOException
* writing is not supported, or attempting to write the file * writing is not supported, or attempting to write the file
* failed, possibly due to permissions or remote disk full, etc. * failed, possibly due to permissions or remote disk full, etc.
@ -159,7 +159,7 @@ public void writePackedRefs() throws IOException {
/** /**
* Handles actual writing of ref files to the git repository, which may * Handles actual writing of ref files to the git repository, which may
* differ slightly depending on the destination and transport. * differ slightly depending on the destination and transport.
* *
* @param file * @param file
* path to ref file. * path to ref file.
* @param content * @param content

16
org.eclipse.jgit/src/org/eclipse/jgit/lib/Repository.java
View File

@ -111,7 +111,7 @@ public class Repository {
/** /**
* Construct a representation of a Git repository. * Construct a representation of a Git repository.
* *
* @param d * @param d
* GIT_DIR (the location of the repository metadata). * GIT_DIR (the location of the repository metadata).
* @throws IOException * @throws IOException
@ -251,7 +251,7 @@ public boolean hasObject(final AnyObjectId objectId) {
/** /**
* @param id * @param id
* SHA-1 of an object. * SHA-1 of an object.
* *
* @return a {@link ObjectLoader} for accessing the data of the named * @return a {@link ObjectLoader} for accessing the data of the named
* object, or null if the object does not exist. * object, or null if the object does not exist.
* @throws IOException * @throws IOException
@ -271,7 +271,7 @@ public ObjectLoader openObject(final AnyObjectId id)
* temporary working space associated with the calling thread. * temporary working space associated with the calling thread.
* @param id * @param id
* SHA-1 of an object. * SHA-1 of an object.
* *
* @return a {@link ObjectLoader} for accessing the data of the named * @return a {@link ObjectLoader} for accessing the data of the named
* object, or null if the object does not exist. * object, or null if the object does not exist.
* @throws IOException * @throws IOException
@ -488,7 +488,7 @@ public Tag mapTag(final String refName, final ObjectId id) throws IOException {
/** /**
* Create a command to update, create or delete a ref in this repository. * Create a command to update, create or delete a ref in this repository.
* *
* @param ref * @param ref
* name of the ref the caller wants to modify. * name of the ref the caller wants to modify.
* @return an update command. The caller must finish populating this command * @return an update command. The caller must finish populating this command
@ -666,7 +666,7 @@ else if (item.equals("")) {
refId = parents[0]; refId = parents[0];
} else } else
throw new IncorrectObjectTypeException(refId, Constants.TYPE_COMMIT); throw new IncorrectObjectTypeException(refId, Constants.TYPE_COMMIT);
} }
} else { } else {
ref = mapObject(refId, null); ref = mapObject(refId, null);
@ -771,7 +771,7 @@ public void close() {
/** /**
* Add a single existing pack to the list of available pack files. * Add a single existing pack to the list of available pack files.
* *
* @param pack * @param pack
* path of the pack file to open. * path of the pack file to open.
* @param idx * @param idx
@ -817,7 +817,7 @@ public String getFullBranch() throws IOException {
ref = ref.substring(5); ref = ref.substring(5);
return ref; return ref;
} }
/** /**
* @return name of current branch. * @return name of current branch.
* @throws IOException * @throws IOException
@ -884,7 +884,7 @@ public Map<String, Ref> getTags() {
* <p> * <p>
* If the ref cannot be peeled (as it does not refer to an annotated tag) * If the ref cannot be peeled (as it does not refer to an annotated tag)
* the peeled id stays null, but {@link Ref#isPeeled()} will be true. * the peeled id stays null, but {@link Ref#isPeeled()} will be true.
* *
* @param ref * @param ref
* The ref to peel * The ref to peel
* @return <code>ref</code> if <code>ref.isPeeled()</code> is true; else a * @return <code>ref</code> if <code>ref.isPeeled()</code> is true; else a

2
org.eclipse.jgit/src/org/eclipse/jgit/lib/Tree.java
View File

@ -605,4 +605,4 @@ public String toString() {
return r.toString(); return r.toString();
} }
} }

2
org.eclipse.jgit/src/org/eclipse/jgit/lib/WindowCache.java
View File

@ -78,7 +78,7 @@ private static final int bits(int newSize) {
* The new configuration is applied immediately. If the new limits are * The new configuration is applied immediately. If the new limits are
* smaller than what what is currently cached, older entries will be purged * smaller than what what is currently cached, older entries will be purged
* as soon as possible to allow the cache to meet the new limit. * as soon as possible to allow the cache to meet the new limit.
* *
* @param packedGitLimit * @param packedGitLimit
* maximum number of bytes to hold within this instance. * maximum number of bytes to hold within this instance.
* @param packedGitWindowSize * @param packedGitWindowSize

4
org.eclipse.jgit/src/org/eclipse/jgit/lib/WindowCursor.java
View File

@ -59,7 +59,7 @@ public final class WindowCursor {
/** /**
* Copy bytes from the window to a caller supplied buffer. * Copy bytes from the window to a caller supplied buffer.
* *
* @param pack * @param pack
* the file the desired window is stored within. * the file the desired window is stored within.
* @param position * @param position
@ -95,7 +95,7 @@ int copy(final PackFile pack, long position, final byte[] dstbuf,
/** /**
* Pump bytes into the supplied inflater as input. * Pump bytes into the supplied inflater as input.
* *
* @param pack * @param pack
* the file the desired window is stored within. * the file the desired window is stored within.
* @param position * @param position

64
org.eclipse.jgit/src/org/eclipse/jgit/lib/WorkDirCheckout.java
View File

@ -67,14 +67,14 @@ public class WorkDirCheckout {
File root; File root;
GitIndex index; GitIndex index;
private boolean failOnConflict = true; private boolean failOnConflict = true;
Tree merge; Tree merge;
/** /**
* If <code>true</code>, will scan first to see if it's possible to check out, * If <code>true</code>, will scan first to see if it's possible to check out,
* otherwise throw {@link CheckoutConflictException}. If <code>false</code>, * otherwise throw {@link CheckoutConflictException}. If <code>false</code>,
* it will silently deal with the problem. * it will silently deal with the problem.
* @param failOnConflict * @param failOnConflict
@ -90,7 +90,7 @@ public void setFailOnConflict(boolean failOnConflict) {
this.index = oldIndex; this.index = oldIndex;
this.merge = repo.mapTree(newIndex.writeTree()); this.merge = repo.mapTree(newIndex.writeTree());
} }
/** /**
* Create a checkout class for checking out one tree, merging with the index * Create a checkout class for checking out one tree, merging with the index
* *
@ -99,7 +99,7 @@ public void setFailOnConflict(boolean failOnConflict) {
* @param index current index * @param index current index
* @param merge tree to check out * @param merge tree to check out
*/ */
public WorkDirCheckout(Repository repo, File root, public WorkDirCheckout(Repository repo, File root,
GitIndex index, Tree merge) { GitIndex index, Tree merge) {
this.repo = repo; this.repo = repo;
this.root = root; this.root = root;
@ -120,7 +120,7 @@ public WorkDirCheckout(Repository repo, File root, Tree head, GitIndex index, Tr
this(repo, root, index, merge); this(repo, root, index, merge);
this.head = head; this.head = head;
} }
/** /**
* Execute this checkout * Execute this checkout
* *
@ -136,7 +136,7 @@ public void checkout() throws IOException {
throw new CheckoutConflictException(entries); throw new CheckoutConflictException(entries);
} }
} }
cleanUpConflicts(); cleanUpConflicts();
if (head == null) if (head == null)
checkoutOutIndexNoHead(); checkoutOutIndexNoHead();
@ -147,7 +147,7 @@ private void checkoutTwoTrees() throws FileNotFoundException, IOException {
for (String path : removed) { for (String path : removed) {
index.remove(root, new File(root, path)); index.remove(root, new File(root, path));
} }
for (java.util.Map.Entry<String, ObjectId> entry : updated.entrySet()) { for (java.util.Map.Entry<String, ObjectId> entry : updated.entrySet()) {
Entry newEntry = index.addEntry(merge.findBlobMember(entry.getKey())); Entry newEntry = index.addEntry(merge.findBlobMember(entry.getKey()));
index.checkoutEntry(root, newEntry); index.checkoutEntry(root, newEntry);
@ -160,7 +160,7 @@ private void checkoutTwoTrees() throws FileNotFoundException, IOException {
Tree head = null; Tree head = null;
HashMap<String, ObjectId> updated = new HashMap<String, ObjectId>(); HashMap<String, ObjectId> updated = new HashMap<String, ObjectId>();
private void checkoutOutIndexNoHead() throws IOException { private void checkoutOutIndexNoHead() throws IOException {
new IndexTreeWalker(index, merge, root, new AbstractIndexTreeVisitor() { new IndexTreeWalker(index, merge, root, new AbstractIndexTreeVisitor() {
public void visitEntry(TreeEntry m, Entry i, File f) throws IOException { public void visitEntry(TreeEntry m, Entry i, File f) throws IOException {
@ -176,7 +176,7 @@ else if (i.getObjectId().equals(m.getId())) {
if (i.isModified(root, true)) if (i.isModified(root, true))
needsCheckout = true; needsCheckout = true;
} else needsCheckout = true; } else needsCheckout = true;
if (needsCheckout) { if (needsCheckout) {
Entry newEntry = index.addEntry(m); Entry newEntry = index.addEntry(m);
index.checkoutEntry(root, newEntry); index.checkoutEntry(root, newEntry);
@ -205,9 +205,9 @@ private void removeEmptyParents(File f) {
if (parentFile.list().length == 0) if (parentFile.list().length == 0)
parentFile.delete(); parentFile.delete();
else break; else break;
parentFile = parentFile.getParentFile(); parentFile = parentFile.getParentFile();
} }
} }
void prescanOneTree() throws IOException { void prescanOneTree() throws IOException {
@ -227,12 +227,12 @@ public void visitEntry(TreeEntry m, Entry i, File file) throws IOException {
}).walk(); }).walk();
conflicts.removeAll(removed); conflicts.removeAll(removed);
} }
private ArrayList<String> listFiles(File file) { private ArrayList<String> listFiles(File file) {
ArrayList<String> list = new ArrayList<String>(); ArrayList<String> list = new ArrayList<String>();
listFiles(file, list); listFiles(file, list);
return list; return list;
} }
private void listFiles(File dir, ArrayList<String> list) { private void listFiles(File dir, ArrayList<String> list) {
for (File f : dir.listFiles()) { for (File f : dir.listFiles()) {
@ -267,24 +267,24 @@ public void visitEntry(TreeEntry treeEntry, TreeEntry auxEntry,
} }
processEntry(treeEntry, auxEntry, indexEntry); processEntry(treeEntry, auxEntry, indexEntry);
} }
@Override @Override
public void finishVisitTree(Tree tree, Tree auxTree, String curDir) throws IOException { public void finishVisitTree(Tree tree, Tree auxTree, String curDir) throws IOException {
if (curDir.length() == 0) return; if (curDir.length() == 0) return;
if (auxTree != null) { if (auxTree != null) {
if (index.getEntry(curDir) != null) if (index.getEntry(curDir) != null)
removed.add(curDir); removed.add(curDir);
} }
} }
}).walk(); }).walk();
// if there's a conflict, don't list it under // if there's a conflict, don't list it under
// to-be-removed, since that messed up our next // to-be-removed, since that messed up our next
// section // section
removed.removeAll(conflicts); removed.removeAll(conflicts);
for (String path : updated.keySet()) { for (String path : updated.keySet()) {
if (index.getEntry(path) == null) { if (index.getEntry(path) == null) {
File file = new File(root, path); File file = new File(root, path);
@ -295,8 +295,8 @@ else if (file.isDirectory()) {
} }
} }
} }
conflicts.removeAll(removed); conflicts.removeAll(removed);
} }
@ -304,11 +304,11 @@ void processEntry(TreeEntry h, TreeEntry m, Entry i) throws IOException {
ObjectId iId = (i == null ? null : i.getObjectId()); ObjectId iId = (i == null ? null : i.getObjectId());
ObjectId mId = (m == null ? null : m.getId()); ObjectId mId = (m == null ? null : m.getId());
ObjectId hId = (h == null ? null : h.getId()); ObjectId hId = (h == null ? null : h.getId());
String name = (i != null ? i.getName() : String name = (i != null ? i.getName() :
(h != null ? h.getFullName() : (h != null ? h.getFullName() :
m.getFullName())); m.getFullName()));
if (i == null) { if (i == null) {
/* /*
I (index) H M Result I (index) H M Result
@ -317,7 +317,7 @@ void processEntry(TreeEntry h, TreeEntry m, Entry i) throws IOException {
1 nothing nothing exists use M 1 nothing nothing exists use M
2 nothing exists nothing remove path from index 2 nothing exists nothing remove path from index
3 nothing exists exists use M */ 3 nothing exists exists use M */
if (h == null) { if (h == null) {
updated.put(name,mId); updated.put(name,mId);
} else if (m == null) { } else if (m == null) {
@ -331,12 +331,12 @@ void processEntry(TreeEntry h, TreeEntry m, Entry i) throws IOException {
----------------------------------------------------- -----------------------------------------------------
4 yes N/A N/A nothing nothing keep index 4 yes N/A N/A nothing nothing keep index
5 no N/A N/A nothing nothing keep index 5 no N/A N/A nothing nothing keep index
6 yes N/A yes nothing exists keep index 6 yes N/A yes nothing exists keep index
7 no N/A yes nothing exists keep index 7 no N/A yes nothing exists keep index
8 yes N/A no nothing exists fail 8 yes N/A no nothing exists fail
9 no N/A no nothing exists fail */ 9 no N/A no nothing exists fail */
if (m == null || mId.equals(iId)) { if (m == null || mId.equals(iId)) {
if (hasParentBlob(merge, name)) { if (hasParentBlob(merge, name)) {
if (i.isModified(root, true)) { if (i.isModified(root, true)) {
@ -355,7 +355,7 @@ void processEntry(TreeEntry h, TreeEntry m, Entry i) throws IOException {
12 yes no N/A exists nothing fail 12 yes no N/A exists nothing fail
13 no no N/A exists nothing fail 13 no no N/A exists nothing fail
*/ */
if (hId.equals(iId)) { if (hId.equals(iId)) {
if (i.isModified(root, true)) { if (i.isModified(root, true)) {
conflicts.add(name); conflicts.add(name);
@ -374,14 +374,14 @@ void processEntry(TreeEntry h, TreeEntry m, Entry i) throws IOException {
conflicts.add(name); conflicts.add(name);
else updated.put(name, mId); else updated.put(name, mId);
} }
} }
} }
private boolean hasParentBlob(Tree t, String name) throws IOException { private boolean hasParentBlob(Tree t, String name) throws IOException {
if (name.indexOf("/") == -1) return false; if (name.indexOf("/") == -1) return false;
String parent = name.substring(0, name.lastIndexOf("/")); String parent = name.substring(0, name.lastIndexOf("/"));
if (t.findBlobMember(parent) != null) if (t.findBlobMember(parent) != null)
return true; return true;
return hasParentBlob(t, parent); return hasParentBlob(t, parent);
} }

14
org.eclipse.jgit/src/org/eclipse/jgit/revplot/AbstractPlotRenderer.java
View File

@ -70,7 +70,7 @@
* starts at (upper left corner is) 0,0. If this is not true (like say in SWT) * starts at (upper left corner is) 0,0. If this is not true (like say in SWT)
* the implementation must perform the cell offset computations within the * the implementation must perform the cell offset computations within the
* various draw methods. * various draw methods.
* *
* @param <TLane> * @param <TLane>
* type of lane being used by the application. * type of lane being used by the application.
* @param <TColor> * @param <TColor>
@ -85,7 +85,7 @@ public abstract class AbstractPlotRenderer<TLane extends PlotLane, TColor> {
/** /**
* Paint one commit using the underlying graphics library. * Paint one commit using the underlying graphics library.
* *
* @param commit * @param commit
* the commit to render in this cell. Must not be null. * the commit to render in this cell. Must not be null.
* @param h * @param h
@ -185,7 +185,7 @@ private int computeDotSize(final int h) {
* If a null lane is supplied the return value must still be acceptable to a * If a null lane is supplied the return value must still be acceptable to a
* drawing method. Usually this means the implementation should return a * drawing method. Usually this means the implementation should return a
* default color. * default color.
* *
* @param myLane * @param myLane
* the current lane. May be null. * the current lane. May be null.
* @return graphics specific color reference. Must be a valid color. * @return graphics specific color reference. Must be a valid color.
@ -194,7 +194,7 @@ private int computeDotSize(final int h) {
/** /**
* Draw a single line within this cell. * Draw a single line within this cell.
* *
* @param color * @param color
* the color to use while drawing the line. * the color to use while drawing the line.
* @param x1 * @param x1
@ -216,7 +216,7 @@ protected abstract void drawLine(TColor color, int x1, int y1, int x2,
* <p> * <p>
* Usually the commit dot is a filled oval in blue, then a drawn oval in * Usually the commit dot is a filled oval in blue, then a drawn oval in
* black, using the same coordinates for both operations. * black, using the same coordinates for both operations.
* *
* @param x * @param x
* upper left of the oval's bounding box. * upper left of the oval's bounding box.
* @param y * @param y
@ -232,7 +232,7 @@ protected abstract void drawLine(TColor color, int x1, int y1, int x2,
* Draw a single boundary commit (aka uninteresting commit) dot. * Draw a single boundary commit (aka uninteresting commit) dot.
* <p> * <p>
* Usually a boundary commit dot is a light gray oval with a white center. * Usually a boundary commit dot is a light gray oval with a white center.
* *
* @param x * @param x
* upper left of the oval's bounding box. * upper left of the oval's bounding box.
* @param y * @param y
@ -249,7 +249,7 @@ protected abstract void drawLine(TColor color, int x1, int y1, int x2,
* <p> * <p>
* The font and colors used to render the text are left up to the * The font and colors used to render the text are left up to the
* implementation. * implementation.
* *
* @param msg * @param msg
* the text to draw. Does not contain LFs. * the text to draw. Does not contain LFs.
* @param x * @param x

12
org.eclipse.jgit/src/org/eclipse/jgit/revplot/PlotCommit.java
View File

@ -49,7 +49,7 @@
/** /**
* A commit reference to a commit in the DAG. * A commit reference to a commit in the DAG.
* *
* @param <L> * @param <L>
* type of lane being used by the plotter. * type of lane being used by the plotter.
* @see PlotCommitList * @see PlotCommitList
@ -69,7 +69,7 @@ public class PlotCommit<L extends PlotLane> extends RevCommit {
/** /**
* Create a new commit. * Create a new commit.
* *
* @param id * @param id
* the identity of this commit. * the identity of this commit.
* @param tags * @param tags
@ -112,7 +112,7 @@ else if (cnt == 1)
/** /**
* Get the number of child commits listed in this commit. * Get the number of child commits listed in this commit.
* *
* @return number of children; always a positive value but can be 0. * @return number of children; always a positive value but can be 0.
*/ */
public final int getChildCount() { public final int getChildCount() {
@ -121,7 +121,7 @@ public final int getChildCount() {
/** /**
* Get the nth child from this commit's child list. * Get the nth child from this commit's child list.
* *
* @param nth * @param nth
* child index to obtain. Must be in the range 0 through * child index to obtain. Must be in the range 0 through
* {@link #getChildCount()}-1. * {@link #getChildCount()}-1.
@ -135,7 +135,7 @@ public final PlotCommit getChild(final int nth) {
/** /**
* Determine if the given commit is a child (descendant) of this commit. * Determine if the given commit is a child (descendant) of this commit.
* *
* @param c * @param c
* the commit to test. * the commit to test.
* @return true if the given commit built on top of this commit. * @return true if the given commit built on top of this commit.
@ -149,7 +149,7 @@ public final boolean isChild(final PlotCommit c) {
/** /**
* Obtain the lane this commit has been plotted into. * Obtain the lane this commit has been plotted into.
* *
* @return the assigned lane for this commit. * @return the assigned lane for this commit.
*/ */
public final L getLane() { public final L getLane() {

6
org.eclipse.jgit/src/org/eclipse/jgit/revplot/PlotCommitList.java
View File

@ -58,7 +58,7 @@
* <p> * <p>
* The source of the list must be a {@link PlotWalk} and {@link #fillTo(int)} * The source of the list must be a {@link PlotWalk} and {@link #fillTo(int)}
* must be used to populate the list. * must be used to populate the list.
* *
* @param <L> * @param <L>
* type of lane used by the application. * type of lane used by the application.
*/ */
@ -98,7 +98,7 @@ public void source(final RevWalk w) {
* <p> * <p>
* This method modifies the passed collection by adding the lanes in any * This method modifies the passed collection by adding the lanes in any
* order. * order.
* *
* @param currCommit * @param currCommit
* the commit the caller needs to get the lanes from. * the commit the caller needs to get the lanes from.
* @param result * @param result
@ -195,7 +195,7 @@ protected L createLane() {
/** /**
* Return colors and other reusable information to the plotter when a lane * Return colors and other reusable information to the plotter when a lane
* is no longer needed. * is no longer needed.
* *
* @param lane * @param lane
*/ */
protected void recycleLane(final L lane) { protected void recycleLane(final L lane) {

2
org.eclipse.jgit/src/org/eclipse/jgit/revplot/PlotLane.java
View File

@ -55,7 +55,7 @@ public class PlotLane {
/** /**
* Logical location of this lane within the graphing plane. * Logical location of this lane within the graphing plane.
* *
* @return location of this lane, 0 through the maximum number of lanes. * @return location of this lane, 0 through the maximum number of lanes.
*/ */
public int getPosition() { public int getPosition() {

2
org.eclipse.jgit/src/org/eclipse/jgit/revplot/PlotWalk.java
View File

@ -73,7 +73,7 @@ public void dispose() {
/** /**
* Create a new revision walker for a given repository. * Create a new revision walker for a given repository.
* *
* @param repo * @param repo
* the repository the walker will obtain data from. * the repository the walker will obtain data from.
*/ */

8
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/AbstractRevQueue.java
View File

@ -55,7 +55,7 @@ abstract class AbstractRevQueue extends Generator {
* This method always adds the commit, even if it is already in the queue or * This method always adds the commit, even if it is already in the queue or
* previously was in the queue but has already been removed. To control * previously was in the queue but has already been removed. To control
* queue admission use {@link #add(RevCommit, RevFlag)}. * queue admission use {@link #add(RevCommit, RevFlag)}.
* *
* @param c * @param c
* commit to add. * commit to add.
*/ */
@ -68,7 +68,7 @@ abstract class AbstractRevQueue extends Generator {
* flag; if it does not already have the flag than the commit is added to * flag; if it does not already have the flag than the commit is added to
* the queue and the flag is set. This later will prevent the commit from * the queue and the flag is set. This later will prevent the commit from
* being added twice. * being added twice.
* *
* @param c * @param c
* commit to add. * commit to add.
* @param queueControl * @param queueControl
@ -88,7 +88,7 @@ public final void add(final RevCommit c, final RevFlag queueControl) {
* flag; if it does not already have the flag than the commit is added to * flag; if it does not already have the flag than the commit is added to
* the queue and the flag is set. This later will prevent the commit from * the queue and the flag is set. This later will prevent the commit from
* being added twice. * being added twice.
* *
* @param c * @param c
* commit whose parents should be added. * commit whose parents should be added.
* @param queueControl * @param queueControl
@ -104,7 +104,7 @@ public final void addParents(final RevCommit c, final RevFlag queueControl) {
/** /**
* Remove the first commit from the queue. * Remove the first commit from the queue.
* *
* @return the first commit of this queue. * @return the first commit of this queue.
*/ */
public abstract RevCommit next(); public abstract RevCommit next();

2
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/BlockRevQueue.java
View File

@ -79,7 +79,7 @@ protected BlockRevQueue() {
* <p> * <p>
* Free lists are not thread-safe. Applications must ensure that all queues * Free lists are not thread-safe. Applications must ensure that all queues
* sharing the same free list are doing so from only a single thread. * sharing the same free list are doing so from only a single thread.
* *
* @param q * @param q
* the other queue we will steal entries from. * the other queue we will steal entries from.
*/ */

2
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/DateRevQueue.java
View File

@ -98,7 +98,7 @@ public RevCommit next() {
/** /**
* Peek at the next commit, without removing it. * Peek at the next commit, without removing it.
* *
* @return the next available commit; null if there are no commits left. * @return the next available commit; null if there are no commits left.
*/ */
public RevCommit peek() { public RevCommit peek() {

2
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/FIFORevQueue.java
View File

@ -82,7 +82,7 @@ public void add(final RevCommit c) {
/** /**
* Insert the commit pointer at the front of the queue. * Insert the commit pointer at the front of the queue.
* *
* @param c * @param c
* the commit to insert into the queue. * the commit to insert into the queue.
*/ */

8
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/Generator.java
View File

@ -55,7 +55,7 @@
* Conceptually a Generator is an iterator or a queue, it returns commits until * Conceptually a Generator is an iterator or a queue, it returns commits until
* there are no more relevant. Generators may be piped/stacked together to * there are no more relevant. Generators may be piped/stacked together to
* create a more complex set of operations. * create a more complex set of operations.
* *
* @see PendingGenerator * @see PendingGenerator
* @see StartGenerator * @see StartGenerator
*/ */
@ -77,7 +77,7 @@ abstract class Generator {
/** /**
* Connect the supplied queue to this generator's own free list (if any). * Connect the supplied queue to this generator's own free list (if any).
* *
* @param q * @param q
* another FIFO queue that wants to share our queue's free list. * another FIFO queue that wants to share our queue's free list.
*/ */
@ -87,7 +87,7 @@ void shareFreeList(final BlockRevQueue q) {
/** /**
* Obtain flags describing the output behavior of this generator. * Obtain flags describing the output behavior of this generator.
* *
* @return one or more of the constants declared in this class, describing * @return one or more of the constants declared in this class, describing
* how this generator produces its results. * how this generator produces its results.
*/ */
@ -95,7 +95,7 @@ void shareFreeList(final BlockRevQueue q) {
/** /**
* Return the next commit to the application, or the next generator. * Return the next commit to the application, or the next generator.
* *
* @return next available commit; null if no more are to be returned. * @return next available commit; null if no more are to be returned.
* @throws MissingObjectException * @throws MissingObjectException
* @throws IncorrectObjectTypeException * @throws IncorrectObjectTypeException

12
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/ObjectWalk.java
View File

@ -92,7 +92,7 @@ public class ObjectWalk extends RevWalk {
/** /**
* Create a new revision and object walker for a given repository. * Create a new revision and object walker for a given repository.
* *
* @param repo * @param repo
* the repository the walker will obtain data from. * the repository the walker will obtain data from.
*/ */
@ -118,7 +118,7 @@ public ObjectWalk(final Repository repo) {
* This method will automatically call {@link RevWalk#markStart(RevCommit)} * This method will automatically call {@link RevWalk#markStart(RevCommit)}
* if passed RevCommit instance, or a RevTag that directly (or indirectly) * if passed RevCommit instance, or a RevTag that directly (or indirectly)
* references a RevCommit. * references a RevCommit.
* *
* @param o * @param o
* the object to start traversing from. The object passed must be * the object to start traversing from. The object passed must be
* from this same revision walker. * from this same revision walker.
@ -169,7 +169,7 @@ public void markStart(RevObject o) throws MissingObjectException,
* This method will automatically call {@link RevWalk#markStart(RevCommit)} * This method will automatically call {@link RevWalk#markStart(RevCommit)}
* if passed RevCommit instance, or a RevTag that directly (or indirectly) * if passed RevCommit instance, or a RevTag that directly (or indirectly)
* references a RevCommit. * references a RevCommit.
* *
* @param o * @param o
* the object to start traversing from. The object passed must be * the object to start traversing from. The object passed must be
* @throws MissingObjectException * @throws MissingObjectException
@ -229,7 +229,7 @@ public RevCommit next() throws MissingObjectException,
/** /**
* Pop the next most recent object. * Pop the next most recent object.
* *
* @return next most recent object; null if traversal is over. * @return next most recent object; null if traversal is over.
* @throws MissingObjectException * @throws MissingObjectException
* one or or more of the next objects are not available from the * one or or more of the next objects are not available from the
@ -323,7 +323,7 @@ private final boolean shouldSkipObject(final RevObject o) {
* This method returns successfully if everything is connected; it throws an * This method returns successfully if everything is connected; it throws an
* exception if there is a connectivity problem. The exception message * exception if there is a connectivity problem. The exception message
* provides some detail about the connectivity failure. * provides some detail about the connectivity failure.
* *
* @throws MissingObjectException * @throws MissingObjectException
* one or or more of the next objects are not available from the * one or or more of the next objects are not available from the
* object database, but were thought to be candidates for * object database, but were thought to be candidates for
@ -357,7 +357,7 @@ public void checkConnectivity() throws MissingObjectException,
* and final output generation. Applications should try to avoid calling it, * and final output generation. Applications should try to avoid calling it,
* and if invoked do so only once per interesting entry, where the name is * and if invoked do so only once per interesting entry, where the name is
* absolutely required for correct function. * absolutely required for correct function.
* *
* @return complete path of the current entry, from the root of the * @return complete path of the current entry, from the root of the
* repository. If the current entry is in a subtree there will be at * repository. If the current entry is in a subtree there will be at
* least one '/' in the returned string. Null if the current entry * least one '/' in the returned string. Null if the current entry

2
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RevBlob.java
View File

@ -52,7 +52,7 @@
public class RevBlob extends RevObject { public class RevBlob extends RevObject {
/** /**
* Create a new blob reference. * Create a new blob reference.
* *
* @param id * @param id
* object name for the blob. * object name for the blob.
*/ */

28
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RevCommit.java
View File

@ -75,7 +75,7 @@ public class RevCommit extends RevObject {
/** /**
* Create a new commit reference. * Create a new commit reference.
* *
* @param id * @param id
* object name for the commit. * object name for the commit.
*/ */
@ -149,7 +149,7 @@ else if (nParents == 1) {
buffer = raw; buffer = raw;
flags |= PARSED; flags |= PARSED;
} }
@Override @Override
public final int getType() { public final int getType() {
return Constants.OBJ_COMMIT; return Constants.OBJ_COMMIT;
@ -187,7 +187,7 @@ static void carryFlags(RevCommit c, final int carry) {
* an unparsed commit or a commit with no parents is discovered. This * an unparsed commit or a commit with no parents is discovered. This
* permits applications to force a flag through the history chain when * permits applications to force a flag through the history chain when
* necessary. * necessary.
* *
* @param flag * @param flag
* the single flag value to carry back onto parents. * the single flag value to carry back onto parents.
*/ */
@ -199,7 +199,7 @@ public void carry(final RevFlag flag) {
/** /**
* Time from the "committer " line of the buffer. * Time from the "committer " line of the buffer.
* *
* @return time, expressed as seconds since the epoch. * @return time, expressed as seconds since the epoch.
*/ */
public final int getCommitTime() { public final int getCommitTime() {
@ -208,7 +208,7 @@ public final int getCommitTime() {
/** /**
* Parse this commit buffer for display. * Parse this commit buffer for display.
* *
* @param walk * @param walk
* revision walker owning this reference. * revision walker owning this reference.
* @return parsed commit. * @return parsed commit.
@ -219,7 +219,7 @@ public final Commit asCommit(final RevWalk walk) {
/** /**
* Get a reference to this commit's tree. * Get a reference to this commit's tree.
* *
* @return tree of this commit. * @return tree of this commit.
*/ */
public final RevTree getTree() { public final RevTree getTree() {
@ -228,7 +228,7 @@ public final RevTree getTree() {
/** /**
* Get the number of parent commits listed in this commit. * Get the number of parent commits listed in this commit.
* *
* @return number of parents; always a positive value but can be 0. * @return number of parents; always a positive value but can be 0.
*/ */
public final int getParentCount() { public final int getParentCount() {
@ -237,7 +237,7 @@ public final int getParentCount() {
/** /**
* Get the nth parent from this commit's parent list. * Get the nth parent from this commit's parent list.
* *
* @param nth * @param nth
* parent index to obtain. Must be in the range 0 through * parent index to obtain. Must be in the range 0 through
* {@link #getParentCount()}-1. * {@link #getParentCount()}-1.
@ -256,7 +256,7 @@ public final RevCommit getParent(final int nth) {
* this commit's parent list. Applications relying on this list should be * this commit's parent list. Applications relying on this list should be
* very careful to ensure they do not modify its contents during their use * very careful to ensure they do not modify its contents during their use
* of it. * of it.
* *
* @return the array of parents. * @return the array of parents.
*/ */
public final RevCommit[] getParents() { public final RevCommit[] getParents() {
@ -270,7 +270,7 @@ public final RevCommit[] getParents() {
* this commit's message buffer within a RevFilter. Applications relying on * this commit's message buffer within a RevFilter. Applications relying on
* this buffer should be very careful to ensure they do not modify its * this buffer should be very careful to ensure they do not modify its
* contents during their use of it. * contents during their use of it.
* *
* @return the raw unparsed commit body. This is <b>NOT A COPY</b>. * @return the raw unparsed commit body. This is <b>NOT A COPY</b>.
* Altering the contents of this buffer may alter the walker's * Altering the contents of this buffer may alter the walker's
* knowledge of this commit, and the results it produces. * knowledge of this commit, and the results it produces.
@ -293,7 +293,7 @@ public final byte[] getRawBuffer() {
* RevFilter implementations should try to use {@link RawParseUtils} to scan * RevFilter implementations should try to use {@link RawParseUtils} to scan
* the {@link #getRawBuffer()} instead, as this will allow faster evaluation * the {@link #getRawBuffer()} instead, as this will allow faster evaluation
* of commits. * of commits.
* *
* @return identity of the author (name, email) and the time the commit was * @return identity of the author (name, email) and the time the commit was
* made by the author; null if no author line was found. * made by the author; null if no author line was found.
*/ */
@ -319,7 +319,7 @@ public final PersonIdent getAuthorIdent() {
* RevFilter implementations should try to use {@link RawParseUtils} to scan * RevFilter implementations should try to use {@link RawParseUtils} to scan
* the {@link #getRawBuffer()} instead, as this will allow faster evaluation * the {@link #getRawBuffer()} instead, as this will allow faster evaluation
* of commits. * of commits.
* *
* @return identity of the committer (name, email) and the time the commit * @return identity of the committer (name, email) and the time the commit
* was made by the committer; null if no committer line was found. * was made by the committer; null if no committer line was found.
*/ */
@ -338,7 +338,7 @@ public final PersonIdent getCommitterIdent() {
* after taking the commit's character set into account and decoding the * after taking the commit's character set into account and decoding the
* buffer using that character set. This method is a fairly expensive * buffer using that character set. This method is a fairly expensive
* operation and produces a new string on each invocation. * operation and produces a new string on each invocation.
* *
* @return decoded commit message as a string. Never null. * @return decoded commit message as a string. Never null.
*/ */
public final String getFullMessage() { public final String getFullMessage() {
@ -360,7 +360,7 @@ public final String getFullMessage() {
* after taking the commit's character set into account and decoding the * after taking the commit's character set into account and decoding the
* buffer using that character set. This method is a fairly expensive * buffer using that character set. This method is a fairly expensive
* operation and produces a new string on each invocation. * operation and produces a new string on each invocation.
* *
* @return decoded commit message as a string. Never null. The returned * @return decoded commit message as a string. Never null. The returned
* string does not contain any LFs, even if the first paragraph * string does not contain any LFs, even if the first paragraph
* spanned multiple lines. Embedded LFs are converted to spaces. * spanned multiple lines. Embedded LFs are converted to spaces.

22
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RevCommitList.java
View File

@ -51,7 +51,7 @@
/** /**
* An ordered list of {@link RevCommit} subclasses. * An ordered list of {@link RevCommit} subclasses.
* *
* @param <E> * @param <E>
* type of subclass of RevCommit the list is storing. * type of subclass of RevCommit the list is storing.
*/ */
@ -69,7 +69,7 @@ public void clear() {
* <p> * <p>
* Same as <code>applyFlag(matching, flag, 0, size())</code>, but without * Same as <code>applyFlag(matching, flag, 0, size())</code>, but without
* the incremental behavior. * the incremental behavior.
* *
* @param matching * @param matching
* the filter to test commits with. If the filter includes a * the filter to test commits with. If the filter includes a
* commit it will have the flag set; if the filter does not * commit it will have the flag set; if the filter does not
@ -102,7 +102,7 @@ public void applyFlag(final RevFilter matching, final RevFlag flag)
* This version allows incremental testing and application, such as from a * This version allows incremental testing and application, such as from a
* background thread that needs to periodically halt processing and send * background thread that needs to periodically halt processing and send
* updates to the UI. * updates to the UI.
* *
* @param matching * @param matching
* the filter to test commits with. If the filter includes a * the filter to test commits with. If the filter includes a
* commit it will have the flag set; if the filter does not * commit it will have the flag set; if the filter does not
@ -159,7 +159,7 @@ public void applyFlag(final RevFilter matching, final RevFlag flag,
* <p> * <p>
* Same as <code>clearFlag(flag, 0, size())</code>, but without the * Same as <code>clearFlag(flag, 0, size())</code>, but without the
* incremental behavior. * incremental behavior.
* *
* @param flag * @param flag
* the flag to remove. Applications are responsible for * the flag to remove. Applications are responsible for
* allocating this flag from the source RevWalk. * allocating this flag from the source RevWalk.
@ -173,7 +173,7 @@ public void clearFlag(final RevFlag flag) {
* <p> * <p>
* This method is actually implemented in terms of: * This method is actually implemented in terms of:
* <code>applyFlag(RevFilter.NONE, flag, rangeBegin, rangeEnd)</code>. * <code>applyFlag(RevFilter.NONE, flag, rangeBegin, rangeEnd)</code>.
* *
* @param flag * @param flag
* the flag to remove. Applications are responsible for * the flag to remove. Applications are responsible for
* allocating this flag from the source RevWalk. * allocating this flag from the source RevWalk.
@ -197,7 +197,7 @@ public void clearFlag(final RevFlag flag, final int rangeBegin,
/** /**
* Find the next commit that has the given flag set. * Find the next commit that has the given flag set.
* *
* @param flag * @param flag
* the flag to test commits against. * the flag to test commits against.
* @param begin * @param begin
@ -227,7 +227,7 @@ public int indexOf(final RevFlag flag, int begin) {
/** /**
* Find the next commit that has the given flag set. * Find the next commit that has the given flag set.
* *
* @param flag * @param flag
* the flag to test commits against. * the flag to test commits against.
* @param begin * @param begin
@ -259,7 +259,7 @@ public int lastIndexOf(final RevFlag flag, int begin) {
/** /**
* Set the revision walker this list populates itself from. * Set the revision walker this list populates itself from.
* *
* @param w * @param w
* the walker to populate from. * the walker to populate from.
* @see #fillTo(int) * @see #fillTo(int)
@ -270,7 +270,7 @@ public void source(final RevWalk w) {
/** /**
* Is this list still pending more items? * Is this list still pending more items?
* *
* @return true if {@link #fillTo(int)} might be able to extend the list * @return true if {@link #fillTo(int)} might be able to extend the list
* size when called. * size when called.
*/ */
@ -286,7 +286,7 @@ public boolean isPending() {
* fewer total commits available from the walk then the method will return * fewer total commits available from the walk then the method will return
* early. Callers can test the final size of the list by {@link #size()} to * early. Callers can test the final size of the list by {@link #size()} to
* determine if the high water mark specified was met. * determine if the high water mark specified was met.
* *
* @param highMark * @param highMark
* number of commits the caller wants this list to contain when * number of commits the caller wants this list to contain when
* the fill operation is complete. * the fill operation is complete.
@ -347,7 +347,7 @@ public void fillTo(final int highMark) throws MissingObjectException,
* Optional callback invoked when commits enter the list by fillTo. * Optional callback invoked when commits enter the list by fillTo.
* <p> * <p>
* This method is only called during {@link #fillTo(int)}. * This method is only called during {@link #fillTo(int)}.
* *
* @param index * @param index
* the list position this object will appear at. * the list position this object will appear at.
* @param e * @param e

2
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RevFlag.java
View File

@ -76,7 +76,7 @@ public class RevFlag {
/** /**
* Get the revision walk instance this flag was created from. * Get the revision walk instance this flag was created from.
* *
* @return the walker this flag was allocated out of, and belongs to. * @return the walker this flag was allocated out of, and belongs to.
*/ */
public RevWalk getRevWalk() { public RevWalk getRevWalk() {

6
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RevFlagSet.java
View File

@ -51,7 +51,7 @@
/** /**
* Multiple application level mark bits for {@link RevObject}s. * Multiple application level mark bits for {@link RevObject}s.
* *
* @see RevFlag * @see RevFlag
*/ */
public class RevFlagSet extends AbstractSet<RevFlag> { public class RevFlagSet extends AbstractSet<RevFlag> {
@ -66,7 +66,7 @@ public RevFlagSet() {
/** /**
* Create a set of flags, copied from an existing set. * Create a set of flags, copied from an existing set.
* *
* @param s * @param s
* the set to copy flags from. * the set to copy flags from.
*/ */
@ -77,7 +77,7 @@ public RevFlagSet(final RevFlagSet s) {
/** /**
* Create a set of flags, copied from an existing collection. * Create a set of flags, copied from an existing collection.
* *
* @param s * @param s
* the collection to copy flags from. * the collection to copy flags from.
*/ */

18
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RevObject.java
View File

@ -89,14 +89,14 @@ final byte[] loadCanonical(final RevWalk walk) throws IOException,
/** /**
* Get Git object type. See {@link Constants}. * Get Git object type. See {@link Constants}.
* *
* @return object type * @return object type
*/ */
public abstract int getType(); public abstract int getType();
/** /**
* Get the name of this object. * Get the name of this object.
* *
* @return unique hash of this object. * @return unique hash of this object.
*/ */
public final ObjectId getId() { public final ObjectId getId() {
@ -115,7 +115,7 @@ public final boolean equals(final Object o) {
/** /**
* Test to see if the flag has been set on this object. * Test to see if the flag has been set on this object.
* *
* @param flag * @param flag
* the flag to test. * the flag to test.
* @return true if the flag has been added to this object; false if not. * @return true if the flag has been added to this object; false if not.
@ -126,7 +126,7 @@ public final boolean has(final RevFlag flag) {
/** /**
* Test to see if any flag in the set has been set on this object. * Test to see if any flag in the set has been set on this object.
* *
* @param set * @param set
* the flags to test. * the flags to test.
* @return true if any flag in the set has been added to this object; false * @return true if any flag in the set has been added to this object; false
@ -138,7 +138,7 @@ public final boolean hasAny(final RevFlagSet set) {
/** /**
* Test to see if all flags in the set have been set on this object. * Test to see if all flags in the set have been set on this object.
* *
* @param set * @param set
* the flags to test. * the flags to test.
* @return true if all flags of the set have been added to this object; * @return true if all flags of the set have been added to this object;
@ -152,7 +152,7 @@ public final boolean hasAll(final RevFlagSet set) {
* Add a flag to this object. * Add a flag to this object.
* <p> * <p>
* If the flag is already set on this object then the method has no effect. * If the flag is already set on this object then the method has no effect.
* *
* @param flag * @param flag
* the flag to mark on this object, for later testing. * the flag to mark on this object, for later testing.
*/ */
@ -162,7 +162,7 @@ public final void add(final RevFlag flag) {
/** /**
* Add a set of flags to this object. * Add a set of flags to this object.
* *
* @param set * @param set
* the set of flags to mark on this object, for later testing. * the set of flags to mark on this object, for later testing.
*/ */
@ -174,7 +174,7 @@ public final void add(final RevFlagSet set) {
* Remove a flag from this object. * Remove a flag from this object.
* <p> * <p>
* If the flag is not set on this object then the method has no effect. * If the flag is not set on this object then the method has no effect.
* *
* @param flag * @param flag
* the flag to remove from this object. * the flag to remove from this object.
*/ */
@ -184,7 +184,7 @@ public final void remove(final RevFlag flag) {
/** /**
* Remove a set of flags from this object. * Remove a set of flags from this object.
* *
* @param set * @param set
* the flag to remove from this object. * the flag to remove from this object.
*/ */

2
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RevObjectList.java
View File

@ -49,7 +49,7 @@
/** /**
* An ordered list of {@link RevObject} subclasses. * An ordered list of {@link RevObject} subclasses.
* *
* @param <E> * @param <E>
* type of subclass of RevObject the list is storing. * type of subclass of RevObject the list is storing.
*/ */

8
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RevTag.java
View File

@ -68,7 +68,7 @@ public class RevTag extends RevObject {
/** /**
* Create a new tag reference. * Create a new tag reference.
* *
* @param id * @param id
* object name for the tag. * object name for the tag.
*/ */
@ -188,7 +188,7 @@ public final String getShortMessage() {
/** /**
* Parse this tag buffer for display. * Parse this tag buffer for display.
* *
* @param walk * @param walk
* revision walker owning this reference. * revision walker owning this reference.
* @return parsed tag. * @return parsed tag.
@ -199,7 +199,7 @@ public Tag asTag(final RevWalk walk) {
/** /**
* Get a reference to the object this tag was placed on. * Get a reference to the object this tag was placed on.
* *
* @return object this tag refers to. * @return object this tag refers to.
*/ */
public final RevObject getObject() { public final RevObject getObject() {
@ -208,7 +208,7 @@ public final RevObject getObject() {
/** /**
* Get the name of this tag, from the tag header. * Get the name of this tag, from the tag header.
* *
* @return name of the tag, according to the tag header. * @return name of the tag, according to the tag header.
*/ */
public final String getTagName() { public final String getTagName() {

2
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RevTree.java
View File

@ -52,7 +52,7 @@
public class RevTree extends RevObject { public class RevTree extends RevObject {
/** /**
* Create a new tree reference. * Create a new tree reference.
* *
* @param id * @param id
* object name for the tree. * object name for the tree.
*/ */

60
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RevWalk.java
View File

@ -128,7 +128,7 @@ public class RevWalk implements Iterable<RevCommit> {
* mark the commit REWRITE. Later we can rewrite the parents of a REWRITE * mark the commit REWRITE. Later we can rewrite the parents of a REWRITE
* child to remove chains of REWRITE commits before we produce the child to * child to remove chains of REWRITE commits before we produce the child to
* the application. * the application.
* *
* @see RewriteGenerator * @see RewriteGenerator
*/ */
static final int REWRITE = 1 << 3; static final int REWRITE = 1 << 3;
@ -185,7 +185,7 @@ public class RevWalk implements Iterable<RevCommit> {
/** /**
* Create a new revision walker for a given repository. * Create a new revision walker for a given repository.
* *
* @param repo * @param repo
* the repository the walker will obtain data from. * the repository the walker will obtain data from.
*/ */
@ -205,7 +205,7 @@ public RevWalk(final Repository repo) {
/** /**
* Get the repository this walker loads objects from. * Get the repository this walker loads objects from.
* *
* @return the repository this walker was created to read. * @return the repository this walker was created to read.
*/ */
public Repository getRepository() { public Repository getRepository() {
@ -224,7 +224,7 @@ public Repository getRepository() {
* handling may be more difficult for the application to explain why a * handling may be more difficult for the application to explain why a
* RevCommit is not actually a commit. The object pool of this walker would * RevCommit is not actually a commit. The object pool of this walker would
* also be 'poisoned' by the non-commit RevCommit. * also be 'poisoned' by the non-commit RevCommit.
* *
* @param c * @param c
* the commit to start traversing from. The commit passed must be * the commit to start traversing from. The commit passed must be
* from this same revision walker. * from this same revision walker.
@ -254,7 +254,7 @@ public void markStart(final RevCommit c) throws MissingObjectException,
/** /**
* Mark commits to start graph traversal from. * Mark commits to start graph traversal from.
* *
* @param list * @param list
* commits to start traversing from. The commits passed must be * commits to start traversing from. The commits passed must be
* from this same revision walker. * from this same revision walker.
@ -294,7 +294,7 @@ public void markStart(final Collection<RevCommit> list)
* handling may be more difficult for the application to explain why a * handling may be more difficult for the application to explain why a
* RevCommit is not actually a commit. The object pool of this walker would * RevCommit is not actually a commit. The object pool of this walker would
* also be 'poisoned' by the non-commit RevCommit. * also be 'poisoned' by the non-commit RevCommit.
* *
* @param c * @param c
* the commit to start traversing from. The commit passed must be * the commit to start traversing from. The commit passed must be
* from this same revision walker. * from this same revision walker.
@ -330,7 +330,7 @@ public void markUninteresting(final RevCommit c)
* commits, and then executes a walk until an answer can be obtained. * commits, and then executes a walk until an answer can be obtained.
* Currently allocated RevFlags that have been added to RevCommit instances * Currently allocated RevFlags that have been added to RevCommit instances
* will be retained through the reset. * will be retained through the reset.
* *
* @param base * @param base
* commit the caller thinks is reachable from <code>tip</code>. * commit the caller thinks is reachable from <code>tip</code>.
* @param tip * @param tip
@ -370,7 +370,7 @@ public boolean isMergedInto(final RevCommit base, final RevCommit tip)
/** /**
* Pop the next most recent commit. * Pop the next most recent commit.
* *
* @return next most recent commit; null if traversal is over. * @return next most recent commit; null if traversal is over.
* @throws MissingObjectException * @throws MissingObjectException
* one or or more of the next commit's parents are not available * one or or more of the next commit's parents are not available
@ -389,7 +389,7 @@ public RevCommit next() throws MissingObjectException,
/** /**
* Obtain the sort types applied to the commits returned. * Obtain the sort types applied to the commits returned.
* *
* @return the sorting strategies employed. At least one strategy is always * @return the sorting strategies employed. At least one strategy is always
* used, but that strategy may be {@link RevSort#NONE}. * used, but that strategy may be {@link RevSort#NONE}.
*/ */
@ -413,7 +413,7 @@ public boolean hasRevSort(RevSort sort) {
* <p> * <p>
* Disables all sorting strategies, then enables only the single strategy * Disables all sorting strategies, then enables only the single strategy
* supplied by the caller. * supplied by the caller.
* *
* @param s * @param s
* a sorting strategy to enable. * a sorting strategy to enable.
*/ */
@ -430,7 +430,7 @@ public void sort(final RevSort s) {
* may take precedence over others. As an example, {@link RevSort#TOPO} must * may take precedence over others. As an example, {@link RevSort#TOPO} must
* take precedence over {@link RevSort#COMMIT_TIME_DESC}, otherwise it * take precedence over {@link RevSort#COMMIT_TIME_DESC}, otherwise it
* cannot enforce its ordering. * cannot enforce its ordering.
* *
* @param s * @param s
* a sorting strategy to enable or disable. * a sorting strategy to enable or disable.
* @param use * @param use
@ -452,7 +452,7 @@ else if (sorting.size() == 0)
/** /**
* Get the currently configured commit filter. * Get the currently configured commit filter.
* *
* @return the current filter. Never null as a filter is always needed. * @return the current filter. Never null as a filter is always needed.
*/ */
public RevFilter getRevFilter() { public RevFilter getRevFilter() {
@ -472,7 +472,7 @@ public RevFilter getRevFilter() {
* unless the filter implementation specifically states it is (and always * unless the filter implementation specifically states it is (and always
* will be) thread-safe. Callers may use {@link RevFilter#clone()} to create * will be) thread-safe. Callers may use {@link RevFilter#clone()} to create
* a unique filter tree for this RevWalk instance. * a unique filter tree for this RevWalk instance.
* *
* @param newFilter * @param newFilter
* the new filter. If null the special {@link RevFilter#ALL} * the new filter. If null the special {@link RevFilter#ALL}
* filter will be used instead, as it matches every commit. * filter will be used instead, as it matches every commit.
@ -486,7 +486,7 @@ public void setRevFilter(final RevFilter newFilter) {
/** /**
* Get the tree filter used to simplify commits by modified paths. * Get the tree filter used to simplify commits by modified paths.
* *
* @return the current filter. Never null as a filter is always needed. If * @return the current filter. Never null as a filter is always needed. If
* no filter is being applied {@link TreeFilter#ALL} is returned. * no filter is being applied {@link TreeFilter#ALL} is returned.
*/ */
@ -507,7 +507,7 @@ public TreeFilter getTreeFilter() {
* Usually callers should be inserting a filter graph including * Usually callers should be inserting a filter graph including
* {@link TreeFilter#ANY_DIFF} along with one or more * {@link TreeFilter#ANY_DIFF} along with one or more
* {@link org.eclipse.jgit.treewalk.filter.PathFilter} instances. * {@link org.eclipse.jgit.treewalk.filter.PathFilter} instances.
* *
* @param newFilter * @param newFilter
* new filter. If null the special {@link TreeFilter#ALL} filter * new filter. If null the special {@link TreeFilter#ALL} filter
* will be used instead, as it matches everything. * will be used instead, as it matches everything.
@ -568,7 +568,7 @@ public RevBlob lookupBlob(final AnyObjectId id) {
* <p> * <p>
* The tree may or may not exist in the repository. It is impossible to tell * The tree may or may not exist in the repository. It is impossible to tell
* from this method's return value. * from this method's return value.
* *
* @param id * @param id
* name of the tree object. * name of the tree object.
* @return reference to the tree object. Never null. * @return reference to the tree object. Never null.
@ -587,7 +587,7 @@ public RevTree lookupTree(final AnyObjectId id) {
* <p> * <p>
* The commit may or may not exist in the repository. It is impossible to * The commit may or may not exist in the repository. It is impossible to
* tell from this method's return value. * tell from this method's return value.
* *
* @param id * @param id
* name of the commit object. * name of the commit object.
* @return reference to the commit object. Never null. * @return reference to the commit object. Never null.
@ -606,7 +606,7 @@ public RevCommit lookupCommit(final AnyObjectId id) {
* <p> * <p>
* The object may or may not exist in the repository. It is impossible to * The object may or may not exist in the repository. It is impossible to
* tell from this method's return value. * tell from this method's return value.
* *
* @param id * @param id
* name of the object. * name of the object.
* @param type * @param type
@ -643,7 +643,7 @@ public RevObject lookupAny(final AnyObjectId id, final int type) {
* Unlike {@link #lookupCommit(AnyObjectId)} this method only returns * Unlike {@link #lookupCommit(AnyObjectId)} this method only returns
* successfully if the commit object exists, is verified to be a commit, and * successfully if the commit object exists, is verified to be a commit, and
* was parsed without error. * was parsed without error.
* *
* @param id * @param id
* name of the commit object. * name of the commit object.
* @return reference to the commit object. Never null. * @return reference to the commit object. Never null.
@ -713,7 +713,7 @@ else if (!(c instanceof RevTree))
* without error. Parsing an object can be expensive as the type must be * without error. Parsing an object can be expensive as the type must be
* determined. For blobs this may mean the blob content was unpacked * determined. For blobs this may mean the blob content was unpacked
* unnecessarily, and thrown away. * unnecessarily, and thrown away.
* *
* @param id * @param id
* name of the object. * name of the object.
* @return reference to the object. Never null. * @return reference to the object. Never null.
@ -768,7 +768,7 @@ public RevObject parseAny(final AnyObjectId id)
* <p> * <p>
* This method only returns successfully if the object exists and was parsed * This method only returns successfully if the object exists and was parsed
* without error. * without error.
* *
* @param obj * @param obj
* the object the caller needs to be parsed. * the object the caller needs to be parsed.
* @throws MissingObjectException * @throws MissingObjectException
@ -806,7 +806,7 @@ public void parseBody(final RevObject obj)
* Applications are only assured to be able to create 24 unique flags on any * Applications are only assured to be able to create 24 unique flags on any
* given revision walker instance. Any flags beyond 24 are offered only if * given revision walker instance. Any flags beyond 24 are offered only if
* the implementation has extra free space within its internal storage. * the implementation has extra free space within its internal storage.
* *
* @param name * @param name
* description of the flag, primarily useful for debugging. * description of the flag, primarily useful for debugging.
* @return newly constructed flag instance. * @return newly constructed flag instance.
@ -832,7 +832,7 @@ int allocFlag() {
* <p> * <p>
* A carried flag is copied from the child commit onto its parents when the * A carried flag is copied from the child commit onto its parents when the
* child commit is popped from the lowest level of walk's internal graph. * child commit is popped from the lowest level of walk's internal graph.
* *
* @param flag * @param flag
* the flag to carry onto parents, if set on a descendant. * the flag to carry onto parents, if set on a descendant.
*/ */
@ -849,7 +849,7 @@ public void carry(final RevFlag flag) {
* <p> * <p>
* A carried flag is copied from the child commit onto its parents when the * A carried flag is copied from the child commit onto its parents when the
* child commit is popped from the lowest level of walk's internal graph. * child commit is popped from the lowest level of walk's internal graph.
* *
* @param set * @param set
* the flags to carry onto parents, if set on a descendant. * the flags to carry onto parents, if set on a descendant.
*/ */
@ -867,7 +867,7 @@ public void carry(final Collection<RevFlag> set) {
* If the flag was previously being carried, the carrying request is * If the flag was previously being carried, the carrying request is
* removed. Disposing of a carried flag while a traversal is in progress has * removed. Disposing of a carried flag while a traversal is in progress has
* an undefined behavior. * an undefined behavior.
* *
* @param flag * @param flag
* the to recycle. * the to recycle.
*/ */
@ -909,7 +909,7 @@ public final void reset() {
* Unlike {@link #dispose()} previously acquired RevObject (and RevCommit) * Unlike {@link #dispose()} previously acquired RevObject (and RevCommit)
* instances are not invalidated. RevFlag instances are not invalidated, but * instances are not invalidated. RevFlag instances are not invalidated, but
* are removed from all RevObjects. * are removed from all RevObjects.
* *
* @param retainFlags * @param retainFlags
* application flags that should <b>not</b> be cleared from * application flags that should <b>not</b> be cleared from
* existing commit objects. * existing commit objects.
@ -924,7 +924,7 @@ public final void resetRetain(final RevFlagSet retainFlags) {
* Unlike {@link #dispose()} previously acquired RevObject (and RevCommit) * Unlike {@link #dispose()} previously acquired RevObject (and RevCommit)
* instances are not invalidated. RevFlag instances are not invalidated, but * instances are not invalidated. RevFlag instances are not invalidated, but
* are removed from all RevObjects. * are removed from all RevObjects.
* *
* @param retainFlags * @param retainFlags
* application flags that should <b>not</b> be cleared from * application flags that should <b>not</b> be cleared from
* existing commit objects. * existing commit objects.
@ -942,7 +942,7 @@ public final void resetRetain(final RevFlag... retainFlags) {
* Unlike {@link #dispose()} previously acquired RevObject (and RevCommit) * Unlike {@link #dispose()} previously acquired RevObject (and RevCommit)
* instances are not invalidated. RevFlag instances are not invalidated, but * instances are not invalidated. RevFlag instances are not invalidated, but
* are removed from all RevObjects. * are removed from all RevObjects.
* *
* @param retainFlags * @param retainFlags
* application flags that should <b>not</b> be cleared from * application flags that should <b>not</b> be cleared from
* existing commit objects. * existing commit objects.
@ -1012,7 +1012,7 @@ public void dispose() {
* <p> * <p>
* If a checked exception is thrown during the walk (see {@link #next()}) * If a checked exception is thrown during the walk (see {@link #next()})
* it is rethrown from the Iterator as a {@link RevWalkException}. * it is rethrown from the Iterator as a {@link RevWalkException}.
* *
* @return an iterator over this walker's commits. * @return an iterator over this walker's commits.
* @see RevWalkException * @see RevWalkException
*/ */
@ -1068,7 +1068,7 @@ private boolean isNotStarted() {
/** /**
* Construct a new unparsed commit for the given object. * Construct a new unparsed commit for the given object.
* *
* @param id * @param id
* the object this walker requires a commit reference for. * the object this walker requires a commit reference for.
* @return a new unparsed reference for the object. * @return a new unparsed reference for the object.

2
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RewriteGenerator.java
View File

@ -65,7 +65,7 @@
* that makes the DAG dense. Not fully buffering the commits first would cause * that makes the DAG dense. Not fully buffering the commits first would cause
* this loop to abort early, due to commits not being parsed and colored * this loop to abort early, due to commits not being parsed and colored
* correctly. * correctly.
* *
* @see RewriteTreeFilter * @see RewriteTreeFilter
*/ */
class RewriteGenerator extends Generator { class RewriteGenerator extends Generator {

2
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/RewriteTreeFilter.java
View File

@ -64,7 +64,7 @@
* the commit is colored with {@link RevWalk#REWRITE}, allowing a later pass * the commit is colored with {@link RevWalk#REWRITE}, allowing a later pass
* implemented by {@link RewriteGenerator} to remove those colored commits from * implemented by {@link RewriteGenerator} to remove those colored commits from
* the DAG. * the DAG.
* *
* @see RewriteGenerator * @see RewriteGenerator
*/ */
class RewriteTreeFilter extends RevFilter { class RewriteTreeFilter extends RevFilter {

2
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/TopoSortGenerator.java
View File

@ -62,7 +62,7 @@ class TopoSortGenerator extends Generator {
* When the constructor completes the supplied generator will have no * When the constructor completes the supplied generator will have no
* commits remaining, as all of the commits will be held inside of this * commits remaining, as all of the commits will be held inside of this
* generator's internal buffer. * generator's internal buffer.
* *
* @param s * @param s
* generator to pull all commits out of, and into this buffer. * generator to pull all commits out of, and into this buffer.
* @throws MissingObjectException * @throws MissingObjectException

4
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/filter/CommitTimeRevFilter.java
View File

@ -57,7 +57,7 @@
public abstract class CommitTimeRevFilter extends RevFilter { public abstract class CommitTimeRevFilter extends RevFilter {
/** /**
* Create a new filter to select commits before a given date/time. * Create a new filter to select commits before a given date/time.
* *
* @param ts * @param ts
* the point in time to cut on. * the point in time to cut on.
* @return a new filter to select commits on or before <code>ts</code>. * @return a new filter to select commits on or before <code>ts</code>.
@ -68,7 +68,7 @@ public static final RevFilter before(final Date ts) {
/** /**
* Create a new filter to select commits after a given date/time. * Create a new filter to select commits after a given date/time.
* *
* @param ts * @param ts
* the point in time to cut on. * the point in time to cut on.
* @return a new filter to select commits on or after <code>ts</code>. * @return a new filter to select commits on or after <code>ts</code>.

6
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/filter/OrRevFilter.java
View File

@ -63,7 +63,7 @@
public abstract class OrRevFilter extends RevFilter { public abstract class OrRevFilter extends RevFilter {
/** /**
* Create a filter with two filters, one of which must match. * Create a filter with two filters, one of which must match.
* *
* @param a * @param a
* first filter to test. * first filter to test.
* @param b * @param b
@ -78,7 +78,7 @@ public static RevFilter create(final RevFilter a, final RevFilter b) {
/** /**
* Create a filter around many filters, one of which must match. * Create a filter around many filters, one of which must match.
* *
* @param list * @param list
* list of filters to match against. Must contain at least 2 * list of filters to match against. Must contain at least 2
* filters. * filters.
@ -96,7 +96,7 @@ public static RevFilter create(final RevFilter[] list) {
/** /**
* Create a filter around many filters, one of which must match. * Create a filter around many filters, one of which must match.
* *
* @param list * @param list
* list of filters to match against. Must contain at least 2 * list of filters to match against. Must contain at least 2
* filters. * filters.

10
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/filter/RevFlagFilter.java
View File

@ -56,7 +56,7 @@
public abstract class RevFlagFilter extends RevFilter { public abstract class RevFlagFilter extends RevFilter {
/** /**
* Create a new filter that tests for a single flag. * Create a new filter that tests for a single flag.
* *
* @param a * @param a
* the flag to test. * the flag to test.
* @return filter that selects only commits with flag <code>a</code>. * @return filter that selects only commits with flag <code>a</code>.
@ -69,7 +69,7 @@ public static RevFilter has(final RevFlag a) {
/** /**
* Create a new filter that tests all flags in a set. * Create a new filter that tests all flags in a set.
* *
* @param a * @param a
* set of flags to test. * set of flags to test.
* @return filter that selects only commits with all flags in <code>a</code>. * @return filter that selects only commits with all flags in <code>a</code>.
@ -83,7 +83,7 @@ public static RevFilter hasAll(final RevFlag... a) {
/** /**
* Create a new filter that tests all flags in a set. * Create a new filter that tests all flags in a set.
* *
* @param a * @param a
* set of flags to test. * set of flags to test.
* @return filter that selects only commits with all flags in <code>a</code>. * @return filter that selects only commits with all flags in <code>a</code>.
@ -94,7 +94,7 @@ public static RevFilter hasAll(final RevFlagSet a) {
/** /**
* Create a new filter that tests for any flag in a set. * Create a new filter that tests for any flag in a set.
* *
* @param a * @param a
* set of flags to test. * set of flags to test.
* @return filter that selects only commits with any flag in <code>a</code>. * @return filter that selects only commits with any flag in <code>a</code>.
@ -108,7 +108,7 @@ public static RevFilter hasAny(final RevFlag... a) {
/** /**
* Create a new filter that tests for any flag in a set. * Create a new filter that tests for any flag in a set.
* *
* @param a * @param a
* set of flags to test. * set of flags to test.
* @return filter that selects only commits with any flag in <code>a</code>. * @return filter that selects only commits with any flag in <code>a</code>.

6
org.eclipse.jgit/src/org/eclipse/jgit/revwalk/filter/SubStringRevFilter.java
View File

@ -56,7 +56,7 @@
public abstract class SubStringRevFilter extends RevFilter { public abstract class SubStringRevFilter extends RevFilter {
/** /**
* Can this string be safely handled by a substring filter? * Can this string be safely handled by a substring filter?
* *
* @param pattern * @param pattern
* the pattern text proposed by the user. * the pattern text proposed by the user.
* @return true if a substring filter can perform this pattern match; false * @return true if a substring filter can perform this pattern match; false
@ -87,7 +87,7 @@ public static boolean safe(final String pattern) {
/** /**
* Construct a new matching filter. * Construct a new matching filter.
* *
* @param patternText * @param patternText
* text to locate. This should be a safe string as described by * text to locate. This should be a safe string as described by
* the {@link #safe(String)} as regular expression meta * the {@link #safe(String)} as regular expression meta
@ -106,7 +106,7 @@ public boolean include(final RevWalk walker, final RevCommit cmit)
/** /**
* Obtain the raw text to match against. * Obtain the raw text to match against.
* *
* @param cmit * @param cmit
* current commit being evaluated. * current commit being evaluated.
* @return sequence for the commit's content that we need to match on. * @return sequence for the commit's content that we need to match on.

2
org.eclipse.jgit/src/org/eclipse/jgit/transport/BasePackFetchConnection.java
View File

@ -535,4 +535,4 @@ private void receivePack(final ProgressMonitor monitor) throws IOException {
private static class CancelledException extends Exception { private static class CancelledException extends Exception {
private static final long serialVersionUID = 1L; private static final long serialVersionUID = 1L;
} }
} }

2
org.eclipse.jgit/src/org/eclipse/jgit/transport/Connection.java
View File

@ -107,4 +107,4 @@ public interface Connection {
*/ */
public void close(); public void close();
} }

6
org.eclipse.jgit/src/org/eclipse/jgit/transport/FetchConnection.java
View File

@ -69,7 +69,7 @@
* <p> * <p>
* FetchConnection instances are not thread safe and may be accessed by only one * FetchConnection instances are not thread safe and may be accessed by only one
* thread at a time. * thread at a time.
* *
* @see Transport * @see Transport
*/ */
public interface FetchConnection extends Connection { public interface FetchConnection extends Connection {
@ -88,7 +88,7 @@ public interface FetchConnection extends Connection {
* should always be preferred over remotely available objects and packs. * should always be preferred over remotely available objects and packs.
* {@link Transport#isFetchThin()} should be honored if applicable. * {@link Transport#isFetchThin()} should be honored if applicable.
* </p> * </p>
* *
* @param monitor * @param monitor
* progress monitor to inform the end-user about the amount of * progress monitor to inform the end-user about the amount of
* work completed, or to indicate cancellation. Implementations * work completed, or to indicate cancellation. Implementations
@ -124,7 +124,7 @@ public void fetch(final ProgressMonitor monitor,
* By returning only true/false (and not the actual list of tags obtained) * By returning only true/false (and not the actual list of tags obtained)
* the transport itself does not need to be aware of whether or not tags * the transport itself does not need to be aware of whether or not tags
* were included in the transfer. * were included in the transfer.
* *
* @return true if the last fetch call implicitly included tag objects; * @return true if the last fetch call implicitly included tag objects;
* false if tags were not implicitly obtained. * false if tags were not implicitly obtained.
*/ */

2
org.eclipse.jgit/src/org/eclipse/jgit/transport/FetchResult.java
View File

@ -52,7 +52,7 @@
/** /**
* Final status after a successful fetch from a remote repository. * Final status after a successful fetch from a remote repository.
* *
* @see Transport#fetch(org.eclipse.jgit.lib.ProgressMonitor, Collection) * @see Transport#fetch(org.eclipse.jgit.lib.ProgressMonitor, Collection)
*/ */
public class FetchResult extends OperationResult { public class FetchResult extends OperationResult {

12
org.eclipse.jgit/src/org/eclipse/jgit/transport/IndexPack.java
View File

@ -104,7 +104,7 @@ public class IndexPack {
* files within the repository's <code>objects</code> directory. To use the * files within the repository's <code>objects</code> directory. To use the
* data contained within them call {@link #renameAndOpenPack()} once the * data contained within them call {@link #renameAndOpenPack()} once the
* indexing is complete. * indexing is complete.
* *
* @param db * @param db
* the repository that will receive the new pack. * the repository that will receive the new pack.
* @param is * @param is
@ -187,7 +187,7 @@ public static IndexPack create(final Repository db, final InputStream is)
/** /**
* Create a new pack indexer utility. * Create a new pack indexer utility.
* *
* @param db * @param db
* @param src * @param src
* stream to read the pack data from. If the stream is buffered * stream to read the pack data from. If the stream is buffered
@ -239,7 +239,7 @@ public void setIndexVersion(final int version) {
* Thin packs are sometimes used during network transfers to allow a delta * Thin packs are sometimes used during network transfers to allow a delta
* to be sent without a base object. Such packs are not permitted on disk. * to be sent without a base object. Such packs are not permitted on disk.
* They can be fixed by copying the base object onto the end of the pack. * They can be fixed by copying the base object onto the end of the pack.
* *
* @param fix * @param fix
* true to enable fixing a thin pack. * true to enable fixing a thin pack.
*/ */
@ -296,10 +296,10 @@ public void setObjectChecking(final boolean on) {
/** /**
* Consume data from the input stream until the packfile is indexed. * Consume data from the input stream until the packfile is indexed.
* *
* @param progress * @param progress
* progress feedback * progress feedback
* *
* @throws IOException * @throws IOException
*/ */
public void index(final ProgressMonitor progress) throws IOException { public void index(final ProgressMonitor progress) throws IOException {
@ -997,7 +997,7 @@ private static class UnresolvedDelta {
* If the call completes successfully the repository this IndexPack instance * If the call completes successfully the repository this IndexPack instance
* was created with will have the objects in the pack available for reading * was created with will have the objects in the pack available for reading
* and use, without needing to scan for packs. * and use, without needing to scan for packs.
* *
* @throws IOException * @throws IOException
* The pack could not be inserted into the repository's objects * The pack could not be inserted into the repository's objects
* directory. The pack no longer exists on disk, as it was * directory. The pack no longer exists on disk, as it was

2
org.eclipse.jgit/src/org/eclipse/jgit/transport/OperationResult.java
View File

@ -136,4 +136,4 @@ void setAdvertisedRefs(final URIish u, final Map<String, Ref> ar) {
void add(final TrackingRefUpdate u) { void add(final TrackingRefUpdate u) {
updates.put(u.getLocalName(), u); updates.put(u.getLocalName(), u);
} }
} }

2
org.eclipse.jgit/src/org/eclipse/jgit/transport/PackTransport.java
View File

@ -52,7 +52,7 @@
* Implementations of PackTransport setup connections and move objects back and * Implementations of PackTransport setup connections and move objects back and
* forth by creating pack files on the source side and indexing them on the * forth by creating pack files on the source side and indexing them on the
* receiving side. * receiving side.
* *
* @see BasePackFetchConnection * @see BasePackFetchConnection
* @see BasePackPushConnection * @see BasePackPushConnection
*/ */

2
org.eclipse.jgit/src/org/eclipse/jgit/transport/PushConnection.java
View File

@ -65,7 +65,7 @@
* <p> * <p>
* PushConnection instances are not thread safe and may be accessed by only one * PushConnection instances are not thread safe and may be accessed by only one
* thread at a time. * thread at a time.
* *
* @see Transport * @see Transport
*/ */
public interface PushConnection extends Connection { public interface PushConnection extends Connection {

24
org.eclipse.jgit/src/org/eclipse/jgit/transport/RefSpec.java
View File

@ -108,7 +108,7 @@ public RefSpec() {
* <li><code>+refs/head/*:refs/remotes/origin/*</code></li> * <li><code>+refs/head/*:refs/remotes/origin/*</code></li>
* <li><code>:refs/head/master</code></li> * <li><code>:refs/head/master</code></li>
* </ul> * </ul>
* *
* @param spec * @param spec
* string describing the specification. * string describing the specification.
* @throws IllegalArgumentException * @throws IllegalArgumentException
@ -150,7 +150,7 @@ private RefSpec(final RefSpec p) {
/** /**
* Check if this specification wants to forcefully update the destination. * Check if this specification wants to forcefully update the destination.
* *
* @return true if this specification asks for updates without merge tests. * @return true if this specification asks for updates without merge tests.
*/ */
public boolean isForceUpdate() { public boolean isForceUpdate() {
@ -159,7 +159,7 @@ public boolean isForceUpdate() {
/** /**
* Create a new RefSpec with a different force update setting. * Create a new RefSpec with a different force update setting.
* *
* @param forceUpdate * @param forceUpdate
* new value for force update in the returned instance. * new value for force update in the returned instance.
* @return a new RefSpec with force update as specified. * @return a new RefSpec with force update as specified.
@ -176,7 +176,7 @@ public RefSpec setForceUpdate(final boolean forceUpdate) {
* If this is a wildcard pattern then the source and destination names * If this is a wildcard pattern then the source and destination names
* returned by {@link #getSource()} and {@link #getDestination()} will not * returned by {@link #getSource()} and {@link #getDestination()} will not
* be actual ref names, but instead will be patterns. * be actual ref names, but instead will be patterns.
* *
* @return true if this specification could match more than one ref. * @return true if this specification could match more than one ref.
*/ */
public boolean isWildcard() { public boolean isWildcard() {
@ -189,7 +189,7 @@ public boolean isWildcard() {
* During a fetch this is the name of the ref on the remote repository we * During a fetch this is the name of the ref on the remote repository we
* are fetching from. During a push this is the name of the ref on the local * are fetching from. During a push this is the name of the ref on the local
* repository we are pushing out from. * repository we are pushing out from.
* *
* @return name (or wildcard pattern) to match the source ref. * @return name (or wildcard pattern) to match the source ref.
*/ */
public String getSource() { public String getSource() {
@ -198,7 +198,7 @@ public String getSource() {
/** /**
* Create a new RefSpec with a different source name setting. * Create a new RefSpec with a different source name setting.
* *
* @param source * @param source
* new value for source in the returned instance. * new value for source in the returned instance.
* @return a new RefSpec with source as specified. * @return a new RefSpec with source as specified.
@ -228,7 +228,7 @@ public RefSpec setSource(final String source) {
* ObjectId should be stored transiently in order to prepare a merge. * ObjectId should be stored transiently in order to prepare a merge.
* <p> * <p>
* If null during a push, use {@link #getSource()} instead. * If null during a push, use {@link #getSource()} instead.
* *
* @return name (or wildcard) pattern to match the destination ref. * @return name (or wildcard) pattern to match the destination ref.
*/ */
public String getDestination() { public String getDestination() {
@ -237,7 +237,7 @@ public String getDestination() {
/** /**
* Create a new RefSpec with a different destination name setting. * Create a new RefSpec with a different destination name setting.
* *
* @param destination * @param destination
* new value for destination in the returned instance. * new value for destination in the returned instance.
* @return a new RefSpec with destination as specified. * @return a new RefSpec with destination as specified.
@ -258,7 +258,7 @@ public RefSpec setDestination(final String destination) {
/** /**
* Create a new RefSpec with a different source/destination name setting. * Create a new RefSpec with a different source/destination name setting.
* *
* @param source * @param source
* new value for source in the returned instance. * new value for source in the returned instance.
* @param destination * @param destination
@ -292,7 +292,7 @@ public boolean matchSource(final String r) {
/** /**
* Does this specification's source description match the ref? * Does this specification's source description match the ref?
* *
* @param r * @param r
* ref whose name should be tested. * ref whose name should be tested.
* @return true if the names match; false otherwise. * @return true if the names match; false otherwise.
@ -314,7 +314,7 @@ public boolean matchDestination(final String r) {
/** /**
* Does this specification's destination description match the ref? * Does this specification's destination description match the ref?
* *
* @param r * @param r
* ref whose name should be tested. * ref whose name should be tested.
* @return true if the names match; false otherwise. * @return true if the names match; false otherwise.
@ -354,7 +354,7 @@ private RefSpec expandFromSourceImp(final String name) {
* <p> * <p>
* Callers must first verify the passed ref matches this specification, * Callers must first verify the passed ref matches this specification,
* otherwise expansion results may be unpredictable. * otherwise expansion results may be unpredictable.
* *
* @param r * @param r
* a ref that matched our source specification. Could be a * a ref that matched our source specification. Could be a
* wildcard also. * wildcard also.

32
org.eclipse.jgit/src/org/eclipse/jgit/transport/RemoteConfig.java
View File

@ -141,7 +141,7 @@ public static List<RemoteConfig> getAllRemoteConfigs(final Config rc)
* This constructor succeeds even if the requested remote is not defined * This constructor succeeds even if the requested remote is not defined
* within the supplied configuration file. If that occurs then there will be * within the supplied configuration file. If that occurs then there will be
* no URIs and no ref specifications known to the new instance. * no URIs and no ref specifications known to the new instance.
* *
* @param rc * @param rc
* the existing configuration to get the remote settings from. * the existing configuration to get the remote settings from.
* The configuration must already be loaded into memory. * The configuration must already be loaded into memory.
@ -195,7 +195,7 @@ public RemoteConfig(final Config rc, final String remoteName)
/** /**
* Update this remote's definition within the configuration. * Update this remote's definition within the configuration.
* *
* @param rc * @param rc
* the configuration file to store ourselves into. * the configuration file to store ourselves into.
*/ */
@ -259,7 +259,7 @@ private void unset(final Config rc, final String key) {
/** /**
* Get the local name this remote configuration is recognized as. * Get the local name this remote configuration is recognized as.
* *
* @return name assigned by the user to this configuration block. * @return name assigned by the user to this configuration block.
*/ */
public String getName() { public String getName() {
@ -268,7 +268,7 @@ public String getName() {
/** /**
* Get all configured URIs under this remote. * Get all configured URIs under this remote.
* *
* @return the set of URIs known to this remote. * @return the set of URIs known to this remote.
*/ */
public List<URIish> getURIs() { public List<URIish> getURIs() {
@ -277,7 +277,7 @@ public List<URIish> getURIs() {
/** /**
* Add a new URI to the end of the list of URIs. * Add a new URI to the end of the list of URIs.
* *
* @param toAdd * @param toAdd
* the new URI to add to this remote. * the new URI to add to this remote.
* @return true if the URI was added; false if it already exists. * @return true if the URI was added; false if it already exists.
@ -290,7 +290,7 @@ public boolean addURI(final URIish toAdd) {
/** /**
* Remove a URI from the list of URIs. * Remove a URI from the list of URIs.
* *
* @param toRemove * @param toRemove
* the URI to remove from this remote. * the URI to remove from this remote.
* @return true if the URI was added; false if it already exists. * @return true if the URI was added; false if it already exists.
@ -334,7 +334,7 @@ public boolean removePushURI(final URIish toRemove) {
/** /**
* Remembered specifications for fetching from a repository. * Remembered specifications for fetching from a repository.
* *
* @return set of specs used by default when fetching. * @return set of specs used by default when fetching.
*/ */
public List<RefSpec> getFetchRefSpecs() { public List<RefSpec> getFetchRefSpecs() {
@ -343,7 +343,7 @@ public List<RefSpec> getFetchRefSpecs() {
/** /**
* Add a new fetch RefSpec to this remote. * Add a new fetch RefSpec to this remote.
* *
* @param s * @param s
* the new specification to add. * the new specification to add.
* @return true if the specification was added; false if it already exists. * @return true if the specification was added; false if it already exists.
@ -380,7 +380,7 @@ public void setPushRefSpecs(final List<RefSpec> specs) {
/** /**
* Remove a fetch RefSpec from this remote. * Remove a fetch RefSpec from this remote.
* *
* @param s * @param s
* the specification to remove. * the specification to remove.
* @return true if the specification existed and was removed. * @return true if the specification existed and was removed.
@ -391,7 +391,7 @@ public boolean removeFetchRefSpec(final RefSpec s) {
/** /**
* Remembered specifications for pushing to a repository. * Remembered specifications for pushing to a repository.
* *
* @return set of specs used by default when pushing. * @return set of specs used by default when pushing.
*/ */
public List<RefSpec> getPushRefSpecs() { public List<RefSpec> getPushRefSpecs() {
@ -400,7 +400,7 @@ public List<RefSpec> getPushRefSpecs() {
/** /**
* Add a new push RefSpec to this remote. * Add a new push RefSpec to this remote.
* *
* @param s * @param s
* the new specification to add. * the new specification to add.
* @return true if the specification was added; false if it already exists. * @return true if the specification was added; false if it already exists.
@ -413,7 +413,7 @@ public boolean addPushRefSpec(final RefSpec s) {
/** /**
* Remove a push RefSpec from this remote. * Remove a push RefSpec from this remote.
* *
* @param s * @param s
* the specification to remove. * the specification to remove.
* @return true if the specification existed and was removed. * @return true if the specification existed and was removed.
@ -428,7 +428,7 @@ public boolean removePushRefSpec(final RefSpec s) {
* This value is only useful for an SSH style connection, where Git is * This value is only useful for an SSH style connection, where Git is
* asking the remote system to execute a program that provides the necessary * asking the remote system to execute a program that provides the necessary
* network protocol. * network protocol.
* *
* @return location of 'git-upload-pack' on the remote system. If no * @return location of 'git-upload-pack' on the remote system. If no
* location has been configured the default of 'git-upload-pack' is * location has been configured the default of 'git-upload-pack' is
* returned instead. * returned instead.
@ -443,7 +443,7 @@ public String getUploadPack() {
* This value is only useful for an SSH style connection, where Git is * This value is only useful for an SSH style connection, where Git is
* asking the remote system to execute a program that provides the necessary * asking the remote system to execute a program that provides the necessary
* network protocol. * network protocol.
* *
* @return location of 'git-receive-pack' on the remote system. If no * @return location of 'git-receive-pack' on the remote system. If no
* location has been configured the default of 'git-receive-pack' is * location has been configured the default of 'git-receive-pack' is
* returned instead. * returned instead.
@ -454,7 +454,7 @@ public String getReceivePack() {
/** /**
* Get the description of how annotated tags should be treated during fetch. * Get the description of how annotated tags should be treated during fetch.
* *
* @return option indicating the behavior of annotated tags in fetch. * @return option indicating the behavior of annotated tags in fetch.
*/ */
public TagOpt getTagOpt() { public TagOpt getTagOpt() {
@ -463,7 +463,7 @@ public TagOpt getTagOpt() {
/** /**
* Set the description of how annotated tags should be treated on fetch. * Set the description of how annotated tags should be treated on fetch.
* *
* @param option * @param option
* method to use when handling annotated tags. * method to use when handling annotated tags.
*/ */

2
org.eclipse.jgit/src/org/eclipse/jgit/transport/SideBandInputStream.java
View File

@ -68,7 +68,7 @@
* <p> * <p>
* Channel 3 results in an exception being thrown, as the remote side has issued * Channel 3 results in an exception being thrown, as the remote side has issued
* an unrecoverable error. * an unrecoverable error.
* *
* @see PacketLineIn#sideband(ProgressMonitor) * @see PacketLineIn#sideband(ProgressMonitor)
*/ */
class SideBandInputStream extends InputStream { class SideBandInputStream extends InputStream {

8
org.eclipse.jgit/src/org/eclipse/jgit/transport/SshSessionFactory.java
View File

@ -66,7 +66,7 @@ public abstract class SshSessionFactory {
* <p> * <p>
* A factory is always available. By default the factory will read from the * A factory is always available. By default the factory will read from the
* user's <code>$HOME/.ssh</code> and assume OpenSSH compatibility. * user's <code>$HOME/.ssh</code> and assume OpenSSH compatibility.
* *
* @return factory the current factory for this JVM. * @return factory the current factory for this JVM.
*/ */
public static SshSessionFactory getInstance() { public static SshSessionFactory getInstance() {
@ -75,7 +75,7 @@ public static SshSessionFactory getInstance() {
/** /**
* Change the JVM-wide factory to a different implementation. * Change the JVM-wide factory to a different implementation.
* *
* @param newFactory * @param newFactory
* factory for future sessions to be created through. If null the * factory for future sessions to be created through. If null the
* default factory will be restored.s * default factory will be restored.s
@ -95,7 +95,7 @@ public static void setInstance(final SshSessionFactory newFactory) {
* <p> * <p>
* The caller must connect the session by invoking <code>connect()</code> * The caller must connect the session by invoking <code>connect()</code>
* if it has not already been connected. * if it has not already been connected.
* *
* @param user * @param user
* username to authenticate as. If null a reasonable default must * username to authenticate as. If null a reasonable default must
* be selected by the implementation. This may be * be selected by the implementation. This may be
@ -118,7 +118,7 @@ public abstract Session getSession(String user, String pass, String host,
/** /**
* Close (or recycle) a session to a host. * Close (or recycle) a session to a host.
* *
* @param session * @param session
* a session previously obtained from this factory's * a session previously obtained from this factory's
* {@link #getSession(String,String, String, int)} method.s * {@link #getSession(String,String, String, int)} method.s

4
org.eclipse.jgit/src/org/eclipse/jgit/transport/TagOpt.java
View File

@ -84,7 +84,7 @@ private TagOpt(final String o) {
/** /**
* Get the command line/configuration file text for this value. * Get the command line/configuration file text for this value.
* *
* @return text that appears in the configuration file to activate this. * @return text that appears in the configuration file to activate this.
*/ */
public String option() { public String option() {
@ -93,7 +93,7 @@ public String option() {
/** /**
* Convert a command line/configuration file text into a value instance. * Convert a command line/configuration file text into a value instance.
* *
* @param o * @param o
* the configuration file text value. * the configuration file text value.
* @return the option that matches the passed parameter. * @return the option that matches the passed parameter.

10
org.eclipse.jgit/src/org/eclipse/jgit/transport/TrackingRefUpdate.java
View File

@ -80,7 +80,7 @@ public class TrackingRefUpdate {
* Get the name of the remote ref. * Get the name of the remote ref.
* <p> * <p>
* Usually this is of the form "refs/heads/master". * Usually this is of the form "refs/heads/master".
* *
* @return the name used within the remote repository. * @return the name used within the remote repository.
*/ */
public String getRemoteName() { public String getRemoteName() {
@ -91,7 +91,7 @@ public String getRemoteName() {
* Get the name of the local tracking ref. * Get the name of the local tracking ref.
* <p> * <p>
* Usually this is of the form "refs/remotes/origin/master". * Usually this is of the form "refs/remotes/origin/master".
* *
* @return the name used within this local repository. * @return the name used within this local repository.
*/ */
public String getLocalName() { public String getLocalName() {
@ -100,7 +100,7 @@ public String getLocalName() {
/** /**
* Get the new value the ref will be (or was) updated to. * Get the new value the ref will be (or was) updated to.
* *
* @return new value. Null if the caller has not configured it. * @return new value. Null if the caller has not configured it.
*/ */
public ObjectId getNewObjectId() { public ObjectId getNewObjectId() {
@ -114,7 +114,7 @@ public ObjectId getNewObjectId() {
* populated with the value of the ref before the lock is taken, but the old * populated with the value of the ref before the lock is taken, but the old
* value may change if someone else modified the ref between the time we * value may change if someone else modified the ref between the time we
* last read it and when the ref was locked for update. * last read it and when the ref was locked for update.
* *
* @return the value of the ref prior to the update being attempted; null if * @return the value of the ref prior to the update being attempted; null if
* the updated has not been attempted yet. * the updated has not been attempted yet.
*/ */
@ -124,7 +124,7 @@ public ObjectId getOldObjectId() {
/** /**
* Get the status of this update. * Get the status of this update.
* *
* @return the status of the update. * @return the status of the update.
*/ */
public Result getResult() { public Result getResult() {

24
org.eclipse.jgit/src/org/eclipse/jgit/transport/Transport.java
View File

@ -91,7 +91,7 @@ public enum Operation {
* Open a new transport instance to connect two repositories. * Open a new transport instance to connect two repositories.
* <p> * <p>
* This method assumes {@link Operation#FETCH}. * This method assumes {@link Operation#FETCH}.
* *
* @param local * @param local
* existing local repository. * existing local repository.
* @param remote * @param remote
@ -197,7 +197,7 @@ public static List<Transport> openAll(final Repository local,
* Open a new transport instance to connect two repositories. * Open a new transport instance to connect two repositories.
* <p> * <p>
* This method assumes {@link Operation#FETCH}. * This method assumes {@link Operation#FETCH}.
* *
* @param local * @param local
* existing local repository. * existing local repository.
* @param cfg * @param cfg
@ -319,7 +319,7 @@ private static boolean doesNotExist(final RemoteConfig cfg) {
/** /**
* Open a new transport instance to connect two repositories. * Open a new transport instance to connect two repositories.
* *
* @param local * @param local
* existing local repository. * existing local repository.
* @param remote * @param remote
@ -520,7 +520,7 @@ private static String findTrackingRefName(final String remoteName,
/** /**
* Create a new transport instance. * Create a new transport instance.
* *
* @param local * @param local
* the repository this instance will fetch into, or push out of. * the repository this instance will fetch into, or push out of.
* This must be the repository passed to * This must be the repository passed to
@ -540,7 +540,7 @@ protected Transport(final Repository local, final URIish uri) {
* Get the URI this transport connects to. * Get the URI this transport connects to.
* <p> * <p>
* Each transport instance connects to at most one URI at any point in time. * Each transport instance connects to at most one URI at any point in time.
* *
* @return the URI describing the location of the remote repository. * @return the URI describing the location of the remote repository.
*/ */
public URIish getURI() { public URIish getURI() {
@ -549,7 +549,7 @@ public URIish getURI() {
/** /**
* Get the name of the remote executable providing upload-pack service. * Get the name of the remote executable providing upload-pack service.
* *
* @return typically "git-upload-pack". * @return typically "git-upload-pack".
*/ */
public String getOptionUploadPack() { public String getOptionUploadPack() {
@ -558,7 +558,7 @@ public String getOptionUploadPack() {
/** /**
* Set the name of the remote executable providing upload-pack services. * Set the name of the remote executable providing upload-pack services.
* *
* @param where * @param where
* name of the executable. * name of the executable.
*/ */
@ -571,7 +571,7 @@ public void setOptionUploadPack(final String where) {
/** /**
* Get the description of how annotated tags should be treated during fetch. * Get the description of how annotated tags should be treated during fetch.
* *
* @return option indicating the behavior of annotated tags in fetch. * @return option indicating the behavior of annotated tags in fetch.
*/ */
public TagOpt getTagOpt() { public TagOpt getTagOpt() {
@ -580,7 +580,7 @@ public TagOpt getTagOpt() {
/** /**
* Set the description of how annotated tags should be treated on fetch. * Set the description of how annotated tags should be treated on fetch.
* *
* @param option * @param option
* method to use when handling annotated tags. * method to use when handling annotated tags.
*/ */
@ -762,7 +762,7 @@ public void setTimeout(final int seconds) {
* tracking refs associated with the remote repository are automatically * tracking refs associated with the remote repository are automatically
* updated if this transport was created from a {@link RemoteConfig} with * updated if this transport was created from a {@link RemoteConfig} with
* fetch RefSpecs defined. * fetch RefSpecs defined.
* *
* @param monitor * @param monitor
* progress monitor to inform the user about our processing * progress monitor to inform the user about our processing
* activity. Must not be null. Use {@link NullProgressMonitor} if * activity. Must not be null. Use {@link NullProgressMonitor} if
@ -898,7 +898,7 @@ public Collection<RemoteRefUpdate> findRemoteRefUpdatesFor(
/** /**
* Begins a new connection for fetching from the remote repository. * Begins a new connection for fetching from the remote repository.
* *
* @return a fresh connection to fetch from the remote repository. * @return a fresh connection to fetch from the remote repository.
* @throws NotSupportedException * @throws NotSupportedException
* the implementation does not support fetching. * the implementation does not support fetching.
@ -910,7 +910,7 @@ public abstract FetchConnection openFetch() throws NotSupportedException,
/** /**
* Begins a new connection for pushing into the remote repository. * Begins a new connection for pushing into the remote repository.
* *
* @return a fresh connection to push into the remote repository. * @return a fresh connection to push into the remote repository.
* @throws NotSupportedException * @throws NotSupportedException
* the implementation does not support pushing. * the implementation does not support pushing.

2
org.eclipse.jgit/src/org/eclipse/jgit/transport/TransportHttp.java
View File

@ -72,7 +72,7 @@
* (server side) repository. Object files are retrieved directly through * (server side) repository. Object files are retrieved directly through
* standard HTTP GET requests, making it easy to serve a Git repository through * standard HTTP GET requests, making it easy to serve a Git repository through
* a standard web host provider that does not offer specific support for Git. * a standard web host provider that does not offer specific support for Git.
* *
* @see WalkFetchConnection * @see WalkFetchConnection
*/ */
public class TransportHttp extends HttpTransport implements WalkTransport { public class TransportHttp extends HttpTransport implements WalkTransport {

Some files were not shown because too many files have changed in this diff Show More