Package com.atlassian.bitbucket.commit

Class AbstractCommitCallback

java.lang.Object

com.atlassian.bitbucket.commit.AbstractCommitCallback

All Implemented Interfaces:

CommitCallback

public abstract class AbstractCommitCallback
extends Object
implements CommitCallback

Convenience implementation of CommitCallback that provides no-op implementations for all methods.

Constructor Summary

Constructors

Constructor	Description
AbstractCommitCallback()

Method Summary

Modifier and Type	Method	Description
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.

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractCommitCallback

public AbstractCommitCallback()

Method Details

onCommit

public boolean onCommit(@Nonnull
 Commit commit)
                 throws IOException

Description copied from interface: CommitCallback

Receives a fully-populated commit for processing.

This method will never be invoked before CommitCallback.onStart(CommitContext), and if it is invoked CommitCallback.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.

Specified by:

onCommit in interface CommitCallback

Parameters:

commit - ignored

Returns:

true

Throws:

IOException - may be thrown by derived classes

onEnd

public void onEnd(@Nonnull
 CommitSummary summary)
           throws IOException

Description copied from interface: CommitCallback

Called after the final commit has been streamed.

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

Specified by:

onEnd in interface CommitCallback

Parameters:

summary - ignored

Throws:

IOException - may be thrown by derived classes

onStart

public void onStart(@Nonnull
 CommitContext context)
             throws IOException

Description copied from interface: CommitCallback

Called before the first commit is streamed.

Specified by:

onStart in interface CommitCallback

Parameters:

context - ignored

Throws:

IOException - may be thrown by derived classes