com.atlassian.bitbucket.commit.graph

Class TraversalCallback

java.lang.Object

com.atlassian.bitbucket.commit.graph.TraversalCallback

public abstract class TraversalCallback
extends Object

A callback which can be used during a traverse of the nodes within a commit graph.

See Also:

CommitService.traverse(TraversalRequest, TraversalCallback)

Constructor Summary

Constructors

Constructor and Description
TraversalCallback()

Method Summary

Modifier and Type	Method and Description
void	onEnd(TraversalSummary summary) Receive a summary of the traversal when it has completed.
abstract TraversalStatus	onNode(CommitGraphNode node) Visit a node in the commit graph.
void	onStart(TraversalContext context)

Methods inherited from class java.lang.Object

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

Constructor Detail

TraversalCallback

public TraversalCallback()

Method Detail

onEnd

public void onEnd(@Nonnull
                  TraversalSummary summary)

Receive a summary of the traversal when it has completed.

Parameters:

summary - summary of the traversal

onNode

public abstract TraversalStatus onNode(@Nonnull
                                       CommitGraphNode node)

Visit a node in the commit graph. All commits are guaranteed to be visited in topological order: that is children will be visited before parents within the graph.

Parameters:

node - the current node being traversed

Returns:

the status of the traversal after visiting the node. If traversal is complete this method will not be invoked again.

onStart

public void onStart(@Nonnull
                    TraversalContext context)