public class

AbstractContentTreeCallback

extends Object
implements ContentTreeCallback
java.lang.Object
   ↳ com.atlassian.bitbucket.content.AbstractContentTreeCallback

Class Overview

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

Summary

Public Constructors
AbstractContentTreeCallback()
Public Methods
void onEnd(ContentTreeSummary summary)
Called after the final tree node has been streamed.
void onStart(ContentTreeContext context)
Called before the first onTreeNode(ContentTreeNode).
boolean onTreeNode(ContentTreeNode node)
Discards the provided ContentTreeNode and returns true to continue streaming.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.bitbucket.content.ContentTreeCallback

Public Constructors

public AbstractContentTreeCallback ()

Public Methods

public void onEnd (ContentTreeSummary summary)

Called after the final tree node has been streamed.

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

Parameters
summary summarizes the tree request and the streamed nodes
Throws
IOException

public void onStart (ContentTreeContext context)

Called before the first onTreeNode(ContentTreeNode).

Parameters
context provides details about the tree request for which nodes are being streamed
Throws
IOException

public boolean onTreeNode (ContentTreeNode node)

Discards the provided ContentTreeNode and returns true to continue streaming.

Parameters
node the current tree node
Returns
  • true if further nodes should be streamed; otherwise, false to stop streaming
Throws
IOException