public class

ContentTree

extends Object
java.lang.Object
   ↳ com.atlassian.confluence.pages.ContentTree

Class Overview

Stores a list of root ContentNodes. The purpose of this tree object is to store a hierarchy of pages (maybe a subset of the full tree) that a user can see after applying permission checks. This saves us from having to repeat permission checks every time we need to display or walk the page hierarchy.

Summary

Public Constructors
ContentTree()
ContentTree(ContentNode rootNode)
Create a ContentTree with only a single root nodel
ContentTree(List<ContentNode> rootContentNodes)
Public Methods
void addRootNode(ContentNode contentNode)
boolean equals(Object obj)
void filter(List<String> ids)
Remove all nodes in this tree whose id does not match the list passed in
List<ContentNode> getAllContentNodes()
Page getPage(long pageId)
List<Page> getPages()
List<ContentNode> getRootNodes()
int hashCode()
boolean isRootNode(ContentNode node)
void removeNode(ContentNode contentNode)
int size()
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public ContentTree ()

public ContentTree (ContentNode rootNode)

Create a ContentTree with only a single root nodel

Parameters
rootNode the only root node in this content tree

public ContentTree (List<ContentNode> rootContentNodes)

Public Methods

public void addRootNode (ContentNode contentNode)

public boolean equals (Object obj)

public void filter (List<String> ids)

Remove all nodes in this tree whose id does not match the list passed in

Parameters
ids List of String representations of the ids of pages

public List<ContentNode> getAllContentNodes ()

public Page getPage (long pageId)

Parameters
pageId the id of the required page
Returns
  • the Page from the ContentTree or null if there is no page with that id in the ContentTree

public List<Page> getPages ()

Returns
  • all the pages associated with the nodes in this tree

public List<ContentNode> getRootNodes ()

public int hashCode ()

public boolean isRootNode (ContentNode node)

public void removeNode (ContentNode contentNode)

public int size ()

Returns
  • the number of nodes in this tree