Package org.xwiki.model.reference

Class EntityReferenceTreeNode

java.lang.Object

org.xwiki.model.reference.EntityReferenceTreeNode

Direct Known Subclasses:

EntityReferenceTree

public class EntityReferenceTreeNode
extends Object

A node in a EntityReferenceTree.

Since:

5.4RC1

Version:

$Id: e4444f7d822a663f2f28b462aee1d0b03ddfaaef $

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EntityReferenceTreeNode(Comparator<String> comparator)

Method Summary

Modifier and Type	Method	Description
EntityReferenceTreeNode	get(String name)	Return the first found direct child with passed name.
EntityReferenceTreeNode	get(EntityReference path)
Collection<EntityReferenceTreeNode>	getChildren()
Collection<EntityReferenceTreeNode>	getChildren(String name)
Collection<EntityReferenceTreeNode>	getChildren(EntityType type)
Collection<EntityReferenceTreeNode>	getChildrenInternal(String name)
Collection<EntityReference>	getLocales()
EntityReference	getReference()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityReferenceTreeNode

protected EntityReferenceTreeNode(Comparator<String> comparator)

Method Detail

getReference

public EntityReference getReference()

Returns:

the reference associated to this node

get

public EntityReferenceTreeNode get(String name)

Return the first found direct child with passed name.

Parameters:

name - the name of the child node

Returns:

the node associated to the passed name

get

public EntityReferenceTreeNode get(EntityReference path)

Parameters:

path - a path in the tree starting from this node, specified as an EntityReference

Returns:

the node associated to the specified path

Since:

7.2M1

getChildren

public Collection<EntityReferenceTreeNode> getChildren()

Returns:

the child reference nodes

getChildren

public Collection<EntityReferenceTreeNode> getChildren(String name)

Parameters:

name - the name of the children to return

Returns:

the children with the passed name

Since:

7.4M1

getChildren

public Collection<EntityReferenceTreeNode> getChildren(EntityType type)

Parameters:

type - the type of the children to return

Returns:

the children with the passed EntityType

Since:

7.4M1

getChildrenInternal

public Collection<EntityReferenceTreeNode> getChildrenInternal(String name)

Parameters:

name - the name of the children to return

Returns:

the children with the passed name

getLocales

public Collection<EntityReference> getLocales()

Returns:

the child references containing a Locale

toString

public String toString()

Overrides:

toString in class Object