Summary: Methods | [Expand All]
public interface

CommitCallback

com.atlassian.stash.commit.CommitCallback
Known Indirect Subclasses

Class Overview

Describes a callback for receiving a stream of commits.

Note: Implementors are strongly encouraged to extend from AbstractCommitCallback. This interface will change over time, and any class implementing it directly will be broken by such changes. Extending from the abstract class will help prevent such breakages.

See Also

Summary

Public Methods
boolean onCommit(Commit commit)
Receives a fully-populated commit for processing.
void onEnd(CommitSummary summary)
Called after the final commit has been streamed.
void onStart(CommitContext context)
Called before the first commit is streamed.

Public Methods

public boolean onCommit (Commit commit)

Receives a fully-populated commit for processing.

This method will never be invoked before onStart(CommitContext), and if it is invoked onEnd(CommitSummary) is guaranteed to be invoked, whether the end happens because this method returns false or because the upstream sender runs out of commits.

Parameters
commit the commit
Returns
  • true if more commits should be provided; otherwise false to end streaming, potentially leaving some number of commits unread
Throws
IOException for implementations which perform I/O

public void onEnd (CommitSummary summary)

Called after the final commit has been streamed.

Note: If there were no commits, this method may be called immediately after onStart(CommitContext) without any calls to onCommit(Commit).

Parameters
summary summarizes the request and the streamed commits
Throws
IOException for implementations which perform I/O

public void onStart (CommitContext context)

Called before the first commit is streamed.

Parameters
context provides details about the request for which commit are being streamed
Throws
IOException for implementations which perform I/O