Top Description Fields Constructors Methods
org.eclipse.jgit.revwalk

pack-priv abstract Class Generator

extends Object
Class Inheritance
Known Direct Subclasses
org.eclipse.jgit.revwalk.MergeBaseGenerator, org.eclipse.jgit.revwalk.PendingGenerator, org.eclipse.jgit.revwalk.RewriteGenerator, org.eclipse.jgit.revwalk.StartGenerator, org.eclipse.jgit.revwalk.TopoNonIntermixSortGenerator, org.eclipse.jgit.revwalk.TopoSortGenerator, org.eclipse.jgit.revwalk.AbstractRevQueue, org.eclipse.jgit.revwalk.BoundaryGenerator, org.eclipse.jgit.revwalk.BoundaryGenerator.InitialGenerator, org.eclipse.jgit.revwalk.DelayRevQueue, org.eclipse.jgit.revwalk.DepthGenerator, org.eclipse.jgit.revwalk.EndGenerator, org.eclipse.jgit.revwalk.FixUninterestingGenerator
Imports
java.io.IOException, org.eclipse.jgit.errors.IncorrectObjectTypeException, .MissingObjectException

Produces commits for RevWalk to return to applications.

Implementations of this basic class provide the real work behind RevWalk. Conceptually a Generator is an iterator or a queue, it returns commits until there are no more relevant. Generators may be piped/stacked together to create a more complex set of operations.

See Also
PendingGenerator, StartGenerator

Field Summary

Modifier and TypeField and Description
protected final boolean
pack-priv static final int
HAS_REWRITE

Output may have RevWalk#REWRITE marked on it.

pack-priv static final int
HAS_UNINTERESTING

Output may have RevWalk#UNINTERESTING marked on it.

pack-priv static final int
pack-priv static final int
SORT_COMMIT_TIME_DESC

Commits are sorted by commit date and time, descending.

pack-priv static final int
SORT_TOPO

Topological ordering is enforced (all children before parents).

Constructor Summary

AccessConstructor and Description
protected
Generator(boolean firstParent)

Method Summary

Modifier and TypeMethod and Description
pack-priv abstract RevCommit

Returns:

next available commit; null if no more are to be returned.
next
()

Return the next commit to the application, or the next generator.

pack-priv abstract int

Returns:

one or more of the constants declared in this class, describing how this generator produces its results.
outputType
()

Obtain flags describing the output behavior of this generator.

pack-priv void
shareFreeList(BlockRevQueue
another FIFO queue that wants to share our queue's free list.
q
)

Connect the supplied queue to this generator's own free list (if any).

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

firstParentback to summary
protected final boolean firstParent
HAS_REWRITEback to summary
pack-priv static final int HAS_REWRITE

Output may have RevWalk#REWRITE marked on it.

HAS_UNINTERESTINGback to summary
pack-priv static final int HAS_UNINTERESTING

Output may have RevWalk#UNINTERESTING marked on it.

NEEDS_REWRITEback to summary
pack-priv static final int NEEDS_REWRITE

Output needs RewriteGenerator.

SORT_COMMIT_TIME_DESCback to summary
pack-priv static final int SORT_COMMIT_TIME_DESC

Commits are sorted by commit date and time, descending.

SORT_TOPOback to summary
pack-priv static final int SORT_TOPO

Topological ordering is enforced (all children before parents).

Constructor Detail

Generatorback to summary
protected Generator(boolean firstParent)

Method Detail

nextback to summary
pack-priv abstract RevCommit next() throws MissingObjectException, IncorrectObjectTypeException, IOException

Return the next commit to the application, or the next generator.

Returns:RevCommit

next available commit; null if no more are to be returned.

Exceptions
MissingObjectException:
if an object is missing
IncorrectObjectTypeException:
if an object has an unexpected type
IOException:
if an IO error occurred
outputTypeback to summary
pack-priv abstract int outputType()

Obtain flags describing the output behavior of this generator.

Returns:int

one or more of the constants declared in this class, describing how this generator produces its results.

shareFreeListback to summary
pack-priv void shareFreeList(BlockRevQueue q)

Connect the supplied queue to this generator's own free list (if any).

Parameters
q:BlockRevQueue

another FIFO queue that wants to share our queue's free list.