com.atlassian.bitbucket.content

Class AbstractContentTreeCallback

java.lang.Object

com.atlassian.bitbucket.content.AbstractContentTreeCallback

All Implemented Interfaces:

ContentTreeCallback

public class AbstractContentTreeCallback
extends Object
implements ContentTreeCallback

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

Constructor Summary

Constructors

Constructor and Description
AbstractContentTreeCallback()

Method Summary

Modifier and Type	Method and Description
void	onEnd(ContentTreeSummary summary) Called after the final tree node has been streamed.
void	onStart(ContentTreeContext context) Called before the first ContentTreeCallback.onTreeNode(ContentTreeNode).
boolean	onTreeNode(ContentTreeNode node) Discards the provided ContentTreeNode and returns true to continue streaming.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractContentTreeCallback

public AbstractContentTreeCallback()

Method Detail

onEnd

public void onEnd(@Nonnull
                  ContentTreeSummary summary)
           throws IOException

Description copied from interface: ContentTreeCallback

Called after the final tree node has been streamed.

Note: If the tree was empty, this method may be called immediately after ContentTreeCallback.onStart(ContentTreeContext) without any calls to ContentTreeCallback.onTreeNode(ContentTreeNode).

Specified by:

onEnd in interface ContentTreeCallback

Parameters:

summary - summarizes the tree request and the streamed nodes

Throws:

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

onStart

public void onStart(@Nonnull
                    ContentTreeContext context)
             throws IOException

Description copied from interface: ContentTreeCallback

Called before the first ContentTreeCallback.onTreeNode(ContentTreeNode).

Specified by:

onStart in interface ContentTreeCallback

Parameters:

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

Throws:

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

onTreeNode

public boolean onTreeNode(@Nonnull
                          ContentTreeNode node)
                   throws IOException

Discards the provided ContentTreeNode and returns true to continue streaming.

Specified by:

onTreeNode in interface ContentTreeCallback

Parameters:

node - the current tree node

Returns:

true if further nodes should be streamed; otherwise, false to stop streaming

Throws:

IOException - may be thrown by implementations which perform I/O operations, such as streaming tree nodes