Deprecate checkoutEntry without ObjectReader

Callers should manage the ObjectReader, as this allows the JGit library to cache
context relevant information across files checked out at the same time. If the
caller only has one file to checkout, it should still explicitly manage the life
span of the ObjectReader.

Change-Id: Ib57fba6cb4b774ccff8c416ef4d32e2b390f16a9

diff --git a/org.eclipse.jgit.test/tst/org/eclipse/jgit/treewalk/FileTreeIteratorTest.java b/org.eclipse.jgit.test/tst/org/eclipse/jgit/treewalk/FileTreeIteratorTest.java
index ab4579009b41bf940d0b367a4f1a596d03b00146..b3dc267b9776d55c111e9b18e17491c407a4f2dd 100644 (file)
--- a/org.eclipse.jgit.test/tst/org/eclipse/jgit/treewalk/FileTreeIteratorTest.java
+++ b/org.eclipse.jgit.test/tst/org/eclipse/jgit/treewalk/FileTreeIteratorTest.java
@@ -291,13 +291,13 @@ public class FileTreeIteratorTest extends RepositoryTestCase {
                // Modify previously committed DirCacheEntry and write it back to disk
                DirCacheEntry dce = db.readDirCache().getEntry("symlink");
                dce.setFileMode(FileMode.SYMLINK);
-               DirCacheCheckout.checkoutEntry(db, f, dce);
+               ObjectReader objectReader = db.newObjectReader();
+               DirCacheCheckout.checkoutEntry(db, f, dce, objectReader);
 
                FileTreeIterator fti = new FileTreeIterator(trash, db.getFS(), db
                                .getConfig().get(WorkingTreeOptions.KEY));
                while (!fti.getEntryPathString().equals("symlink"))
                        fti.next(1);
-               ObjectReader objectReader = db.newObjectReader();
                assertFalse(fti.isModified(dce, false, objectReader));
                objectReader.release();
        }

diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/dircache/DirCacheCheckout.java b/org.eclipse.jgit/src/org/eclipse/jgit/dircache/DirCacheCheckout.java
index 9f340c11913532600f2632911f47802047d1361c..a9b36b0fbb83ac3d7668ea9f5315c97acea2ca60 100644 (file)
--- a/org.eclipse.jgit/src/org/eclipse/jgit/dircache/DirCacheCheckout.java
+++ b/org.eclipse.jgit/src/org/eclipse/jgit/dircache/DirCacheCheckout.java
@@ -1163,7 +1163,9 @@ public class DirCacheCheckout {
         * @param entry
         *            the entry containing new mode and content
         * @throws IOException
+        * @deprecated Use the overloaded form that accepts {@link ObjectReader}.
         */
+       @Deprecated
        public static void checkoutEntry(final Repository repository, File f,
                        DirCacheEntry entry) throws IOException {
                ObjectReader or = repository.newObjectReader();