com.atlassian.bitbucket.content

Class AbstractChangeCallback

java.lang.Object

com.atlassian.bitbucket.content.AbstractChangeCallback

All Implemented Interfaces:

ChangeCallback

public class AbstractChangeCallback
extends Object
implements ChangeCallback

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

Constructor Summary

Constructors

Constructor and Description
AbstractChangeCallback()

Method Summary

Modifier and Type	Method and Description
boolean	onChange(Change change) Discards the provided Change and returns true to continue streaming.
void	onEnd(ChangeSummary summary) Called after the final change has been streamed.
void	onStart(ChangeContext context) Called before the first change is streamed.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractChangeCallback

public AbstractChangeCallback()

Method Detail

onChange

public boolean onChange(@Nonnull
                        Change change)
                 throws IOException

Discards the provided Change and returns true to continue streaming.

Specified by:

onChange in interface ChangeCallback

Parameters:

change - ignored

Returns:

true

Throws:

IOException - may be thrown by derived classes

onEnd

public void onEnd(@Nonnull
                  ChangeSummary summary)
           throws IOException

Description copied from interface: ChangeCallback

Called after the final change has been streamed.

Note: If there were no changes, this method may be called immediately after ChangeCallback.onStart(ChangeContext) without any calls to ChangeCallback.onChange(Change).

Specified by:

onEnd in interface ChangeCallback

Parameters:

summary - summarizes the request and the streamed changes

Throws:

IOException - may be thrown by implementations which perform I/O.

onStart

public void onStart(@Nonnull
                    ChangeContext context)
             throws IOException

Description copied from interface: ChangeCallback

Called before the first change is streamed.

Specified by:

onStart in interface ChangeCallback

Parameters:

context - provides details about the request for which changes are being streamed

Throws:

IOException - may be thrown by implementations which perform I/O.