public class DirCacheBuildIterator extends DirCacheIterator
DirCache as part of a
TreeWalk.
Like DirCacheIterator this iterator allows
a DirCache to be used in parallel with other sorts of iterators in a
TreeWalk. However any entry which appears in the source DirCache and which is
skipped by the TreeFilter is automatically copied into
DirCacheBuilder, thus retaining it in the
newly updated index.
This iterator is suitable for update processes, or even a simple delete algorithm. For example deleting a path:
final DirCache dirc = db.lockDirCache();
final DirCacheBuilder edit = dirc.builder();
final TreeWalk walk = new TreeWalk(db);
walk.reset();
walk.setRecursive(true);
walk.setFilter(PathFilter.create("name/to/remove"));
walk.addTree(new DirCacheBuildIterator(edit));
while (walk.next())
; // do nothing on a match as we want to remove matches
edit.commit();
cache, currentEntry, currentSubtree, ptrattributesNode, DEFAULT_PATH_SIZE, mode, parent, path, pathLen, pathOffset, zeroid| Constructor and Description |
|---|
DirCacheBuildIterator(DirCacheBuilder dcb)
Create a new iterator for an already loaded DirCache instance.
|
| Modifier and Type | Method and Description |
|---|---|
AbstractTreeIterator |
createSubtreeIterator(ObjectReader reader)
Create a new iterator for the current entry's subtree.
|
protected boolean |
needsStopWalk()
Whether the iterator implements
AbstractTreeIterator.stopWalk(). |
void |
skip()
Advance to the next tree entry, populating this iterator with its data.
|
void |
stopWalk()
Indicates to the iterator that no more entries will be read.
|
back, createEmptyTreeIterator, eof, first, getDirCacheEntry, getEntryAttributesNode, hasId, idBuffer, idOffset, next, resetcreateSubtreeIterator, ensurePathCapacity, findFile, findFile, getEntryFileMode, getEntryObjectId, getEntryObjectId, getEntryPathBuffer, getEntryPathHashCode, getEntryPathLength, getEntryPathString, getEntryRawMode, getName, getNameLength, getNameOffset, growPath, idEqual, isWorkTree, pathCompare, pathCompare, toStringpublic DirCacheBuildIterator(DirCacheBuilder dcb)
The iterator implementation may copy part of the cache's data during construction, so the cache must be read in prior to creating the iterator.
dcb - the cache builder for the cache to walk. The cache must be
already loaded into memory.public AbstractTreeIterator createSubtreeIterator(ObjectReader reader) throws IncorrectObjectTypeException, IOException
The parent reference of the iterator must be this,
otherwise the caller would not be able to exit out of the subtree
iterator correctly and return to continue walking this.
createSubtreeIterator in class DirCacheIteratorreader - reader to load the tree data from.IncorrectObjectTypeException - the current entry is not actually a tree and cannot be parsed
as though it were a tree.IOException - a loose object or pack file could not be read.public void skip()
throws CorruptObjectException
This method behaves like seek(1) but is called by
TreeWalk only if a
TreeFilter was used and ruled
out the current entry from the results. In such cases this tree iterator
may perform special behavior.
skip in class AbstractTreeIteratorCorruptObjectException - the tree is invalid.public void stopWalk()
This is only invoked by TreeWalk when the iteration is aborted early due
to a StopWalkException being thrown from
within a TreeFilter.
stopWalk in class AbstractTreeIteratorprotected boolean needsStopWalk()
AbstractTreeIterator.stopWalk().needsStopWalk in class AbstractTreeIteratortrue if the iterator implements AbstractTreeIterator.stopWalk().Copyright © 2018 Eclipse JGit Project. All rights reserved.