Package org.eclipse.xtext.ide.editor.hierarchy

Class DefaultHierarchyNode

java.lang.Object

org.eclipse.xtext.ide.editor.hierarchy.DefaultHierarchyNode

All Implemented Interfaces:

IHierarchyNode, INavigatable

public class DefaultHierarchyNode
extends java.lang.Object
implements IHierarchyNode

Since:

2.10

Constructor Summary

Constructors

Constructor	Description
DefaultHierarchyNode()

Method Summary

Modifier and Type	Method	Description
org.eclipse.xtext.resource.IEObjectDescription	getElement()
java.lang.Object	getNavigationElement()	Returns an instance containing enough information to identify an editor that should be opened and a region that should be revealed.
IHierarchyNode	getParent()
java.util.List<IHierarchyNodeReference>	getReferences()
protected boolean	internalIsRecursive()
boolean	isRecursive()
boolean	mayHaveChildren()
void	setElement(org.eclipse.xtext.resource.IEObjectDescription element)
void	setMayHaveChildren(boolean mayHaveChildren)
void	setParent(IHierarchyNode parent)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultHierarchyNode

public DefaultHierarchyNode()

Method Detail

getNavigationElement

public java.lang.Object getNavigationElement()

Description copied from interface: INavigatable

Returns an instance containing enough information to identify an editor that should be opened and a region that should be revealed.

Typical navigation elements are resource, object and reference descriptions.

Avoid usage of resource sets, resources and eobjects as navigation elements, since it can lead to memory leaks.

Specified by:

getNavigationElement in interface INavigatable

isRecursive

public boolean isRecursive()

Specified by:

isRecursive in interface IHierarchyNode

Returns:

whether there is a parent (can be transitive) containing the same element as the node

internalIsRecursive

protected boolean internalIsRecursive()

mayHaveChildren

public boolean mayHaveChildren()

Specified by:

mayHaveChildren in interface IHierarchyNode

Returns:

whether the node may have children; e.g. a recursive node cannot have children

getParent

public IHierarchyNode getParent()

Specified by:

getParent in interface IHierarchyNode

Returns:

a parent; null if the node is a root

setParent

public void setParent(IHierarchyNode parent)

setMayHaveChildren

public void setMayHaveChildren(boolean mayHaveChildren)

getElement

public org.eclipse.xtext.resource.IEObjectDescription getElement()

Specified by:

getElement in interface IHierarchyNode

Returns:

an associated element that is used to build child nodes

setElement

public void setElement(org.eclipse.xtext.resource.IEObjectDescription element)

getReferences

public java.util.List<IHierarchyNodeReference> getReferences()

Specified by:

getReferences in interface IHierarchyNode

Returns:

references used to reach the node from a parent; empty if the node is a root