Class DirCacheBuilder

java.lang.Object
org.eclipse.jgit.dircache.BaseDirCacheEditor
org.eclipse.jgit.dircache.DirCacheBuilder

public class DirCacheBuilder extends BaseDirCacheEditor
Updates a DirCache by adding individual DirCacheEntrys.

A builder always starts from a clean slate and appends in every single DirCacheEntry which the final updated index must have to reflect its new content.

For maximum performance applications should add entries in path name order. Adding entries out of order is permitted, however a final sorting pass will be implicitly performed during finish() to correct any out-of-order entries. Duplicate detection is also delayed until the sorting is complete.

See Also:
  • Field Details

    • sorted

      private boolean sorted
  • Constructor Details

    • DirCacheBuilder

      protected DirCacheBuilder(DirCache dc, int ecnt)
      Construct a new builder.
      Parameters:
      dc - the cache this builder will eventually update.
      ecnt - estimated number of entries the builder will have upon completion. This sizes the initial entry table.
  • Method Details

    • add

      public void add(DirCacheEntry newEntry)
      Append one entry into the resulting entry list.

      The entry is placed at the end of the entry list. If the entry causes the list to now be incorrectly sorted a final sorting phase will be automatically enabled within finish().

      The internal entry table is automatically expanded if there is insufficient space for the new addition.

      Parameters:
      newEntry - the new entry to add.
      Throws:
      IllegalArgumentException - If the FileMode of the entry was not set by the caller.
    • keep

      public void keep(int pos, int cnt)
      Add a range of existing entries from the destination cache.

      The entries are placed at the end of the entry list. If any of the entries causes the list to now be incorrectly sorted a final sorting phase will be automatically enabled within finish().

      This method copies from the destination cache, which has not yet been updated with this editor's new table. So all offsets into the destination cache are not affected by any updates that may be currently taking place in this editor.

      The internal entry table is automatically expanded if there is insufficient space for the new additions.

      Parameters:
      pos - first entry to copy from the destination cache.
      cnt - number of entries to copy.
    • addTree

      public void addTree(byte[] pathPrefix, int stage, ObjectReader reader, AnyObjectId tree) throws IOException
      Recursively add an entire tree into this builder.

      If pathPrefix is "a/b" and the tree contains file "c" then the resulting DirCacheEntry will have the path "a/b/c".

      All entries are inserted at stage 0, therefore assuming that the application will not insert any other paths with the same pathPrefix.

      Parameters:
      pathPrefix - UTF-8 encoded prefix to mount the tree's entries at. If the path does not end with '/' one will be automatically inserted as necessary.
      stage - stage of the entries when adding them.
      reader - reader the tree(s) will be read from during recursive traversal. This must be the same repository that the resulting DirCache would be written out to (or used in) otherwise the caller is simply asking for deferred MissingObjectExceptions. Caller is responsible for releasing this reader when done.
      tree - the tree to recursively add. This tree's contents will appear under pathPrefix. The ObjectId must be that of a tree; the caller is responsible for dereferencing a tag or commit (if necessary).
      Throws:
      IOException - a tree cannot be read to iterate through its entries.
    • createTreeParser

      private static CanonicalTreeParser createTreeParser(byte[] pathPrefix, ObjectReader reader, AnyObjectId tree) throws IOException
      Throws:
      IOException
    • isTree

      private static boolean isTree(CanonicalTreeParser p)
    • enterTree

      private static CanonicalTreeParser enterTree(CanonicalTreeParser p, ObjectReader reader) throws IOException
      Throws:
      IOException
    • toEntry

      private static DirCacheEntry toEntry(int stage, CanonicalTreeParser i)
    • finish

      public void finish()
      Finish this builder and update the destination DirCache.

      When this method completes this builder instance is no longer usable by the calling application. A new builder must be created to make additional changes to the index entries.

      After completion the DirCache returned by BaseDirCacheEditor.getDirCache() will contain all modifications.

      Note to implementors: Make sure BaseDirCacheEditor.entries is fully sorted then invoke BaseDirCacheEditor.replace() to update the DirCache with the new table.

      Specified by:
      finish in class BaseDirCacheEditor
    • beforeAdd

      private void beforeAdd(DirCacheEntry newEntry)
    • resort

      private void resort()
    • bad

      private static IllegalStateException bad(DirCacheEntry a, String msg)