public class DirCacheBuilder extends BaseDirCacheEditor
DirCache
by adding individual
DirCacheEntry
s.
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.
DirCacheEditor
Modifier and Type | Field and Description |
---|---|
private boolean |
sorted |
cache, entries, entryCnt
Modifier | Constructor and Description |
---|---|
protected |
DirCacheBuilder(DirCache dc,
int ecnt)
Construct a new builder.
|
Modifier and Type | Method and Description |
---|---|
void |
add(DirCacheEntry newEntry)
Append one entry into the resulting entry list.
|
void |
addTree(byte[] pathPrefix,
int stage,
ObjectReader reader,
AnyObjectId tree)
Recursively add an entire tree into this builder.
|
private static java.lang.IllegalStateException |
bad(DirCacheEntry a,
java.lang.String msg) |
private void |
beforeAdd(DirCacheEntry newEntry) |
private static CanonicalTreeParser |
createTreeParser(byte[] pathPrefix,
ObjectReader reader,
AnyObjectId tree) |
private static CanonicalTreeParser |
enterTree(CanonicalTreeParser p,
ObjectReader reader) |
void |
finish()
Finish this builder and update the destination
DirCache . |
private static boolean |
isTree(CanonicalTreeParser p) |
void |
keep(int pos,
int cnt)
Add a range of existing entries from the destination cache.
|
private void |
resort() |
private static DirCacheEntry |
toEntry(int stage,
CanonicalTreeParser i) |
commit, fastAdd, fastKeep, getDirCache, replace
protected DirCacheBuilder(DirCache dc, int ecnt)
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.public void add(DirCacheEntry newEntry)
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.
newEntry
- the new entry to add.java.lang.IllegalArgumentException
- If the FileMode of the entry was not set by the caller.public void keep(int pos, int cnt)
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.
pos
- first entry to copy from the destination cache.cnt
- number of entries to copy.public void addTree(byte[] pathPrefix, int stage, ObjectReader reader, AnyObjectId tree) throws java.io.IOException
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.
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).java.io.IOException
- a tree cannot be read to iterate through its entries.private static CanonicalTreeParser createTreeParser(byte[] pathPrefix, ObjectReader reader, AnyObjectId tree) throws java.io.IOException
java.io.IOException
private static boolean isTree(CanonicalTreeParser p)
private static CanonicalTreeParser enterTree(CanonicalTreeParser p, ObjectReader reader) throws java.io.IOException
java.io.IOException
private static DirCacheEntry toEntry(int stage, CanonicalTreeParser i)
public void finish()
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.
finish
in class BaseDirCacheEditor
private void beforeAdd(DirCacheEntry newEntry)
private void resort()
private static java.lang.IllegalStateException bad(DirCacheEntry a, java.lang.String msg)