JGit 7.2.0.202503040940-r · org.eclipse.jgit.dircache.DirCacheBuilder

Modifier and Type	Field and Description
private boolean	sorted

Access	Constructor and Description
protected	DirCacheBuilder(DirCache the cache this builder will eventually update. dc, int estimated number of entries the builder will have upon completion. This sizes the initial entry table. ecnt) Construct a new builder.

Method Summary

Modifier and Type	Method and Description
public void	add(DirCacheEntry the new entry to add. newEntry) Append one entry into the resulting entry list.
public void	addTree(byte[] 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. pathPrefix, int stage of the entries when adding them. stage, ObjectReader 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. reader, AnyObjectId 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). tree) Recursively add an entire tree into this builder.
private static IllegalStateException	bad(DirCacheEntry a, 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)
public void	finish() Implements abstract org.eclipse.jgit.dircache.BaseDirCacheEditor.finish. Finish this builder and update the destination `org.eclipse.jgit.dircache.DirCache`.
private static boolean	isTree(CanonicalTreeParser p)
public void	keep(int first entry to copy from the destination cache. pos, int number of entries to copy. cnt) Add a range of existing entries from the destination cache.
private void	resort()
private static DirCacheEntry	toEntry(int stage, CanonicalTreeParser i)

Inherited from org.eclipse.jgit.dircache.BaseDirCacheEditor:: commit fastAdd fastKeep getDirCache replace

sorted	back to summary
private boolean sorted

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

Method Detail

add back to summary

add	back to summary
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:DirCacheEntry the new entry to add. Exceptions IllegalArgumentException: If the FileMode of the entry was not set by the caller.

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:DirCacheEntry: the new entry to add.

Exceptions

IllegalArgumentException:: If the FileMode of the entry was not set by the caller.

addTree back to summary

addTree	back to summary
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:byte[] 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:int stage of the entries when adding them. reader:ObjectReader 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:AnyObjectId 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). Exceptions IOException: a tree cannot be read to iterate through its entries.

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:byte[]: 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:int: stage of the entries when adding them.
reader:ObjectReader: 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:AnyObjectId: 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).

Exceptions

IOException:: a tree cannot be read to iterate through its entries.

bad	back to summary
private static IllegalStateException bad(DirCacheEntry a, String msg)

beforeAdd	back to summary
private void beforeAdd(DirCacheEntry newEntry)

createTreeParser	back to summary
private static CanonicalTreeParser createTreeParser(byte[] pathPrefix, ObjectReader reader, AnyObjectId tree) throws IOException

enterTree	back to summary
private static CanonicalTreeParser enterTree(CanonicalTreeParser p, ObjectReader reader) throws IOException

finish back to summary

finish	back to summary
public void finish() Implements abstract org.eclipse.jgit.dircache.BaseDirCacheEditor.finish. Doc from org.eclipse.jgit.dircache.BaseDirCacheEditor.finish. Finish this builder and update the destination `org.eclipse.jgit.dircache.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 `getDirCache()` will contain all modifications. Note to implementors: Make sure `entries` is fully sorted then invoke `replace()` to update the DirCache with the new table. Annotations @Override

public void finish()

Implements abstract org.eclipse.jgit.dircache.BaseDirCacheEditor.finish.

Doc from org.eclipse.jgit.dircache.BaseDirCacheEditor.finish.

Finish this builder and update the destination org.eclipse.jgit.dircache.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 getDirCache() will contain all modifications.

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

Annotations

@Override

isTree	back to summary
private static boolean isTree(CanonicalTreeParser p)

keep back to summary

keep	back to summary
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:int first entry to copy from the destination cache. cnt:int number of entries to copy.

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:int: first entry to copy from the destination cache.
cnt:int: number of entries to copy.

resort	back to summary
private void resort()

toEntry	back to summary
private static DirCacheEntry toEntry(int stage, CanonicalTreeParser i)

public Class DirCacheBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail