Package com.intellij.ui.tree

Class AbstractTreeWalker<N>

java.lang.Object

com.intellij.ui.tree.AbstractTreeWalker<N>

public abstract class AbstractTreeWalker<N>
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
AbstractTreeWalker(TreeVisitor visitor) Creates a new tree walker with the specified tree visitor.
AbstractTreeWalker(TreeVisitor visitor, java.util.function.Function<? super N,java.lang.Object> converter) Creates a new tree walker with the specified node converter, which allows to generate a tree path expected by the given tree visitor.

Method Summary

Modifier and Type	Method and Description
protected abstract java.util.Collection<N>	getChildren(N node) Returns a list of child nodes for the specified node.
Promise<javax.swing.tree.TreePath>	promise()
void	setChildren(java.util.Collection<? extends N> children) Sets the children, awaited by the walker, and continues to traverse a tree structure.
void	setError(java.lang.Throwable error) Stops visiting a tree structure by specifying a cause.
void	start(N node) Starts visiting a tree structure from the specified root node.
void	start(javax.swing.tree.TreePath parent, N node) Starts visiting a tree structure from the specified node.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractTreeWalker

public AbstractTreeWalker(TreeVisitor visitor)

Creates a new tree walker with the specified tree visitor.

Parameters:

visitor - an object that controls visiting a tree structure

AbstractTreeWalker

public AbstractTreeWalker(TreeVisitor visitor,
                          java.util.function.Function<? super N,java.lang.Object> converter)

Creates a new tree walker with the specified node converter, which allows to generate a tree path expected by the given tree visitor.

Parameters:

visitor - an object that controls visiting a tree structure

converter - a node converter for the path components

Method Detail

getChildren

protected abstract java.util.Collection<N> getChildren(N node)

Returns a list of child nodes for the specified node. This method is called by the walker only if the visitor returned the CONTINUE action. The walker will be paused if it returns null. To continue user should call the setChildren(java.util.Collection<? extends N>) method.

Parameters:

node - a node in a tree structure

Returns:

children for the specified node or null if children will be set later

setChildren

public void setChildren(java.util.Collection<? extends N> children)

Sets the children, awaited by the walker, and continues to traverse a tree structure.

Parameters:

children - a list of child nodes for the node specified in the getChildren(N) method

Throws:

java.lang.IllegalStateException - if it is called in unexpected state

promise

public Promise<javax.swing.tree.TreePath> promise()

Returns:

a promise that will be resolved when visiting is finished

setError

public void setError(java.lang.Throwable error)

Stops visiting a tree structure by specifying a cause.

start

public void start(N node)

Starts visiting a tree structure from the specified root node.

Parameters:

node - a tree root or null if nothing to traverse

start

public void start(javax.swing.tree.TreePath parent,
                  N node)

Starts visiting a tree structure from the specified node.

Parameters:

parent - a parent tree path or null for a root node

node - a tree node or null if nothing to traverse