Package com.intellij.ui.tree

Class TreePathUtil

java.lang.Object

com.intellij.ui.tree.TreePathUtil

public class TreePathUtil
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
TreePathUtil()

Method Summary

Modifier and Type	Method and Description
static <T> javax.swing.tree.TreePath	convertArrayToTreePath(T... array)
static <T> javax.swing.tree.TreePath	convertArrayToTreePath(T [] array, java.util.function.Function<? super T,java.lang.Object> converter)
static <T> javax.swing.tree.TreePath	convertCollectionToTreePath(java.lang.Iterable<? extends T> collection)
static <T> javax.swing.tree.TreePath	convertCollectionToTreePath(java.lang.Iterable<? extends T> collection, java.util.function.Function<? super T,java.lang.Object> converter)
static java.lang.Object[]	convertTreePathToArray(javax.swing.tree.TreePath path)
static java.lang.Object[]	convertTreePathToArray(javax.swing.tree.TreePath path, java.util.function.Function<java.lang.Object,java.lang.Object> converter)
static java.lang.String[]	convertTreePathToStrings(javax.swing.tree.TreePath path)
static javax.swing.tree.TreePath	createTreePath(javax.swing.tree.TreePath parent, java.lang.Object component)
static javax.swing.tree.TreePath	findAncestor(javax.swing.tree.TreePath path, java.util.function.Predicate<javax.swing.tree.TreePath> predicate)
static javax.swing.tree.TreePath	findCommonAncestor(java.lang.Iterable<? extends javax.swing.tree.TreePath> paths)
static javax.swing.tree.TreePath	findCommonAncestor(javax.swing.tree.TreePath... paths)
static <T> javax.swing.tree.TreePath	pathToCustomNode(T node, java.util.function.Function<? super T,? extends T> getParent)
static <T> javax.swing.tree.TreePath	pathToCustomNode(T node, java.util.function.Function<? super T,? extends T> getParent, java.util.function.Function<? super T,java.lang.Object> converter)
static javax.swing.tree.TreePath	pathToTreeNode(javax.swing.tree.TreeNode node)
static javax.swing.tree.TreePath	pathToTreeNode(javax.swing.tree.TreeNode node, java.util.function.Function<? super javax.swing.tree.TreeNode,java.lang.Object> converter)
static javax.swing.tree.TreeNode	toTreeNode(javax.swing.tree.TreePath path)
static javax.swing.tree.TreeNode[]	toTreeNodes(javax.swing.tree.TreePath... paths)
static javax.swing.tree.TreePath	toTreePath(javax.swing.tree.TreeNode node)
static javax.swing.tree.TreePath []	toTreePathArray(java.util.Collection<javax.swing.tree.TreePath> collection)
static javax.swing.tree.TreePath[]	toTreePaths(javax.swing.tree.TreeNode... nodes)

Methods inherited from class java.lang.Object

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

Constructor Detail

TreePathUtil

public TreePathUtil()

Method Detail

createTreePath

public static javax.swing.tree.TreePath createTreePath(javax.swing.tree.TreePath parent,
                                                       java.lang.Object component)

Parameters:

parent - the parent path or null to indicate the root

component - the last path component

Returns:

a tree path with all the parent components plus the given component

convertTreePathToStrings

public static java.lang.String[] convertTreePathToStrings(javax.swing.tree.TreePath path)

Parameters:

path - a tree path to convert

Returns:

an array with the string representations of path components or null if the specified path is wrong or a path component is null or its string representation is null

convertTreePathToArray

public static java.lang.Object[] convertTreePathToArray(javax.swing.tree.TreePath path)

Parameters:

path - a tree path to convert

Returns:

an array with the same path components or null if the specified path is wrong or a path component is null

convertTreePathToArray

public static java.lang.Object[] convertTreePathToArray(javax.swing.tree.TreePath path,
                                                        java.util.function.Function<java.lang.Object,java.lang.Object> converter)

Parameters:

path - a tree path to convert

converter - a function to convert path components

Returns:

an array with the converted path components or null if the specified path is wrong or a path component is null or a path component is converted to null

convertArrayToTreePath

@SafeVarargs
public static <T> javax.swing.tree.TreePath convertArrayToTreePath(T... array)

Parameters:

array - an array of path components to convert

Returns:

a tree path with the same path components or null if the specified array is empty or a path component is null or a path component is converted to null

convertArrayToTreePath

public static <T> javax.swing.tree.TreePath convertArrayToTreePath(T [] array,
                                                                   java.util.function.Function<? super T,java.lang.Object> converter)

Parameters:

array - an array of path components to convert

converter - a function to convert path components

Returns:

a tree path with the converted path components or null if the specified array is empty or a path component is null or a path component is converted to null

convertCollectionToTreePath

public static <T> javax.swing.tree.TreePath convertCollectionToTreePath(java.lang.Iterable<? extends T> collection)

Parameters:

collection - a collection of path components to convert

Returns:

a tree path with the converted path components or null if the specified collection is empty or a path component is null or a path component is converted to null

convertCollectionToTreePath

public static <T> javax.swing.tree.TreePath convertCollectionToTreePath(java.lang.Iterable<? extends T> collection,
                                                                        java.util.function.Function<? super T,java.lang.Object> converter)

Parameters:

collection - a collection of path components to convert

converter - a function to convert path components

Returns:

a tree path with the converted path components or null if the specified collection is empty or a path component is null or a path component is converted to null

pathToTreeNode

public static javax.swing.tree.TreePath pathToTreeNode(javax.swing.tree.TreeNode node)

Parameters:

node - the tree node to get the path for

Returns:

a tree path with the converted path components or null if a path component is null or a path component is converted to null

pathToTreeNode

public static javax.swing.tree.TreePath pathToTreeNode(javax.swing.tree.TreeNode node,
                                                       java.util.function.Function<? super javax.swing.tree.TreeNode,java.lang.Object> converter)

Parameters:

node - the tree node to get the path for

converter - a function to convert path components

Returns:

a tree path with the converted path components or null if a path component is null or a path component is converted to null

pathToCustomNode

public static <T> javax.swing.tree.TreePath pathToCustomNode(T node,
                                                             java.util.function.Function<? super T,? extends T> getParent)

Parameters:

node - the node to get the path for

getParent - a function to get a parent node for the given one

Returns:

a tree path with the converted path components or null if a path component is null or a path component is converted to null

pathToCustomNode

public static <T> javax.swing.tree.TreePath pathToCustomNode(T node,
                                                             java.util.function.Function<? super T,? extends T> getParent,
                                                             java.util.function.Function<? super T,java.lang.Object> converter)

Parameters:

node - the node to get the path for

getParent - a function to get a parent node for the given one

converter - a function to convert path components

Returns:

a tree path with the converted path components or null if a path component is null or a path component is converted to null

toTreePathArray

public static javax.swing.tree.TreePath [] toTreePathArray(java.util.Collection<javax.swing.tree.TreePath> collection)

toTreeNode

public static javax.swing.tree.TreeNode toTreeNode(javax.swing.tree.TreePath path)

toTreeNodes

public static javax.swing.tree.TreeNode[] toTreeNodes(javax.swing.tree.TreePath... paths)

toTreePath

public static javax.swing.tree.TreePath toTreePath(javax.swing.tree.TreeNode node)

toTreePaths

public static javax.swing.tree.TreePath[] toTreePaths(javax.swing.tree.TreeNode... nodes)

findAncestor

public static javax.swing.tree.TreePath findAncestor(javax.swing.tree.TreePath path,
                                                     java.util.function.Predicate<javax.swing.tree.TreePath> predicate)

Parameters:

path - a tree path to iterate through ancestors

predicate - a predicate that tests every ancestor of the given path

Returns:

an ancestor of the given path, or null if the path does not have any applicable ancestor

findCommonAncestor

public static javax.swing.tree.TreePath findCommonAncestor(javax.swing.tree.TreePath... paths)

Parameters:

paths - an array of tree paths to iterate through

Returns:

a common ancestor for the given paths, or null if these paths do not have one

findCommonAncestor

public static javax.swing.tree.TreePath findCommonAncestor(java.lang.Iterable<? extends javax.swing.tree.TreePath> paths)

Parameters:

paths - a collection of tree paths to iterate through

Returns:

a common ancestor for the given paths, or null if these paths do not have one