Module org.eclipse.jgit

Package org.eclipse.jgit.revwalk

Class DepthWalk.RevWalk

java.lang.Object

org.eclipse.jgit.revwalk.RevWalk

org.eclipse.jgit.revwalk.DepthWalk.RevWalk

All Implemented Interfaces:

AutoCloseable, Iterable<RevCommit>, DepthWalk

Enclosing interface:

DepthWalk

public static class DepthWalk.RevWalk
extends RevWalk
implements DepthWalk

Subclass of RevWalk that performs depth filtering.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jgit.revwalk.DepthWalk

DepthWalk.Commit, DepthWalk.ObjectWalk, DepthWalk.RevWalk

Constructor Summary

Constructors

Constructor	Description
RevWalk(ObjectReader or, int depth)
RevWalk(Repository repo, int depth)

Method Summary

Modifier and Type	Method	Description
protected RevCommit	createCommit(AnyObjectId id)	Construct a new unparsed commit for the given object.
RevFlag	getDeepenNotFlag()
List<ObjectId>	getDeepenNots()
int	getDeepenSince()
int	getDepth()	Get depth to filter to.
RevFlag	getReinterestingFlag()	Get flag marking commits that are interesting again.
RevFlag	getUnshallowFlag()	Get flag marking commits that should become unshallow.
void	markRoot(RevCommit c)	Mark a root commit (i.e., one whose depth should be considered 0.)
void	setDeepenNots(List<ObjectId> deepenNots)	Mark objects that the client specified using --shallow-exclude.
void	setDeepenSince(int limit)	Sets the deepen-since value.
DepthWalk.ObjectWalk	toObjectWalkWithSameObjects()	Create and return an ObjectWalk using the same objects.

Methods inherited from class org.eclipse.jgit.revwalk.RevWalk

assertNoCommitsMarkedStart, assertNotStarted, assumeShallow, carry, carry, close, createReachabilityChecker, dispose, disposeFlag, getMergedInto, getMergedInto, getObjectReader, getRevFilter, getRevSort, getTreeFilter, hasRevSort, isFirstParent, isMergedInto, isMergedIntoAll, isMergedIntoAny, isRetainBody, iterator, lookupAny, lookupBlob, lookupCommit, lookupOrNull, lookupTag, lookupTree, markStart, markStart, markUninteresting, newFlag, next, parseAny, parseAny, parseBody, parseCommit, parseHeaders, parseTag, parseTree, peel, reset, reset, resetRetain, resetRetain, retainOnReset, retainOnReset, setFirstParent, setRetainBody, setRevFilter, setRewriteParents, setTreeFilter, sort, sort

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

RevWalk

public RevWalk(Repository repo,
               int depth)

Parameters:

repo - Repository to walk

depth - Maximum depth to return

RevWalk

public RevWalk(ObjectReader or,
               int depth)

Parameters:

or - ObjectReader to use

depth - Maximum depth to return

Method Detail

markRoot

public void markRoot(RevCommit c)
              throws MissingObjectException,
                     IncorrectObjectTypeException,
                     IOException

Mark a root commit (i.e., one whose depth should be considered 0.)

Parameters:

c - Commit to mark

Throws:

IOException

IncorrectObjectTypeException

MissingObjectException

createCommit

protected RevCommit createCommit(AnyObjectId id)

Description copied from class: RevWalk

Construct a new unparsed commit for the given object.

Overrides:

createCommit in class RevWalk

Parameters:

id - the object this walker requires a commit reference for.

Returns:

a new unparsed reference for the object.

getDepth

public int getDepth()

Description copied from interface: DepthWalk

Get depth to filter to.

Specified by:

getDepth in interface DepthWalk

Returns:

Depth to filter to.

getDeepenSince

public int getDeepenSince()

Specified by:

getDeepenSince in interface DepthWalk

Returns:

the deepen-since value; if not 0, this walk only returns commits whose commit time is at or after this limit

setDeepenSince

public void setDeepenSince(int limit)

Sets the deepen-since value.

Parameters:

limit - new deepen-since value

Since:

5.2

getDeepenNots

public List<ObjectId> getDeepenNots()

Specified by:

getDeepenNots in interface DepthWalk

Returns:

the objects specified by the client using --shallow-exclude

setDeepenNots

public void setDeepenNots(List<ObjectId> deepenNots)

Mark objects that the client specified using --shallow-exclude. Objects that are not commits have no effect.

Parameters:

deepenNots - specified objects

Since:

5.2

getUnshallowFlag

public RevFlag getUnshallowFlag()

Description copied from interface: DepthWalk

Get flag marking commits that should become unshallow.

Specified by:

getUnshallowFlag in interface DepthWalk

Returns:

flag marking commits that should become unshallow.

getReinterestingFlag

public RevFlag getReinterestingFlag()

Description copied from interface: DepthWalk

Get flag marking commits that are interesting again.

Specified by:

getReinterestingFlag in interface DepthWalk

Returns:

flag marking commits that are interesting again.

getDeepenNotFlag

public RevFlag getDeepenNotFlag()

Specified by:

getDeepenNotFlag in interface DepthWalk

Returns:

flag marking commits that are to be excluded because of --shallow-exclude

toObjectWalkWithSameObjects

public DepthWalk.ObjectWalk toObjectWalkWithSameObjects()

Description copied from class: RevWalk

Create and return an ObjectWalk using the same objects.

Prior to using this method, the caller must reset this RevWalk to clean any flags that were used during the last traversal.

The returned ObjectWalk uses the same ObjectReader, internal object pool, and free RevFlags. Once the ObjectWalk is created, this RevWalk should not be used anymore.

Overrides:

toObjectWalkWithSameObjects in class RevWalk

Returns:

a new walk, using the exact same object pool.

Since:

4.5