Tree (hutool 5.8.33 API)

java.lang.Object
- java.util.AbstractMap<K,V>
- - java.util.HashMap<K,V>
  - - java.util.LinkedHashMap<String,Object>
    - - cn.hutool.core.lang.tree.Tree<T>

Type Parameters:

T - ID类型

All Implemented Interfaces:

Node<T>, Serializable, Cloneable, Comparable<Node<T>>, Map<String,Object>
```
public class Tree<T>
extends LinkedHashMap<String,Object>
implements Node<T>
```
通过转换器将你的实体转化为TreeNodeMap节点实体属性都存在此处,属性有序，可支持排序

Since:

5.2.1

Author:

liangbaikai

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

Constructors
Constructor and Description

Tree()

Tree(TreeNodeConfig treeNodeConfig)
构造

Constructors
Constructor and Description
`Tree()`
`Tree(TreeNodeConfig treeNodeConfig)` 构造

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Tree<T>`	`addChildren(Tree<T>... children)` 增加子节点，同时关联子节点的父节点为当前节点
`Tree<T>`	`cloneTree()` 递归克隆当前节点（即克隆整个树，保留字段值）注意，此方法只会克隆节点，节点属性如果是引用类型，不会克隆
`Tree<T>`	`filter(Filter<Tree<T>> filter)` 递归过滤当前树，注意此方法会修改当前树通过`Filter`指定的过滤规则，本节点或子节点满足过滤条件，则保留当前节点及其所有子节点，否则抛弃节点及其子节点
`Tree<T>`	`filterNew(Filter<Tree<T>> filter)` 递归过滤并生成新的树通过`Filter`指定的过滤规则，本节点或子节点满足过滤条件，则保留当前节点，否则抛弃节点及其子节点
`List<Tree<T>>`	`getChildren()` 获取所有子节点
`TreeNodeConfig`	`getConfig()` 获取节点配置
`T`	`getId()` 获取ID
`CharSequence`	`getName()` 获取节点标签名称
`Tree<T>`	`getNode(T id)` 获取ID对应的节点，如果有多个ID相同的节点，只返回第一个。
`Tree<T>`	`getParent()` 获取父节点
`T`	`getParentId()` 获取父节点ID
`List<CharSequence>`	`getParentsName(boolean includeCurrentNode)` 获取所有父节点名称列表比如有个人在研发1部，他上面有研发部，接着上面有技术中心返回结果就是：[研发一部, 研发中心, 技术中心]
`List<CharSequence>`	`getParentsName(T id, boolean includeCurrentNode)` 获取所有父节点名称列表比如有个人在研发1部，他上面有研发部，接着上面有技术中心返回结果就是：[研发一部, 研发中心, 技术中心]
`Comparable<?>`	`getWeight()` 获取权重
`boolean`	`hasChild()` 是否有子节点，无子节点则此为叶子节点
`void`	`putExtra(String key, Object value)` 扩展属性
`Tree<T>`	`setChildren(List<Tree<T>> children)` 设置子节点，设置后会覆盖所有原有子节点
`Tree<T>`	`setId(T id)` 设置ID
`Tree<T>`	`setName(CharSequence name)` 设置节点标签名称
`Tree<T>`	`setParent(Tree<T> parent)` 设置父节点
`Tree<T>`	`setParentId(T parentId)` 设置父节点ID
`Tree<T>`	`setWeight(Comparable<?> weight)` 设置权重
`String`	`toString()`
`void`	`walk(Consumer<Tree<T>> consumer)` 递归树并处理子树下的节点：

Methods inherited from class java.util.LinkedHashMap
clear, containsValue, entrySet, forEach, get, getOrDefault, keySet, removeEldestEntry, replaceAll, values

Methods inherited from class java.util.HashMap
clone, compute, computeIfAbsent, computeIfPresent, containsKey, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Methods inherited from class java.util.AbstractMap
equals, hashCode

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface cn.hutool.core.lang.tree.Node
compareTo

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, containsKey, equals, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

- Constructor Detail
  - Tree
```
public Tree()
```
  - Tree
```
public Tree(TreeNodeConfig treeNodeConfig)
```
    构造
    
    Parameters:
    
    treeNodeConfig - TreeNode配置
- Method Detail
  - getConfig
```
public TreeNodeConfig getConfig()
```
    获取节点配置
    
    Returns:
    
    节点配置
    
    Since:
    
    5.7.2
  - getParent
```
public Tree<T> getParent()
```
    获取父节点
    
    Returns:
    
    父节点
    
    Since:
    
    5.2.4
  - getNode
```
public Tree<T> getNode(T id)
```
    获取ID对应的节点，如果有多个ID相同的节点，只返回第一个。
    此方法只查找此节点及子节点，采用广度优先遍历。
    
    Parameters:
    
    id - ID
    
    Returns:
    
    节点
    
    Since:
    
    5.2.4
  - getParentsName
```
public List<CharSequence> getParentsName(T id,
                                         boolean includeCurrentNode)
```
    获取所有父节点名称列表
    比如有个人在研发1部，他上面有研发部，接着上面有技术中心
    返回结果就是：[研发一部, 研发中心, 技术中心]
    
    Parameters:
    
    id - 节点ID
    
    includeCurrentNode - 是否包含当前节点的名称
    
    Returns:
    
    所有父节点名称列表
    
    Since:
    
    5.2.4
  - getParentsName
```
public List<CharSequence> getParentsName(boolean includeCurrentNode)
```
    获取所有父节点名称列表
    比如有个人在研发1部，他上面有研发部，接着上面有技术中心
    返回结果就是：[研发一部, 研发中心, 技术中心]
    
    Parameters:
    
    includeCurrentNode - 是否包含当前节点的名称
    
    Returns:
    
    所有父节点名称列表
    
    Since:
    
    5.2.4
  - setParent
```
public Tree<T> setParent(Tree<T> parent)
```
    设置父节点
    
    Parameters:
    
    parent - 父节点
    
    Returns:
    
    this
    
    Since:
    
    5.2.4
  - getId
```
public T getId()
```
    Description copied from interface: Node
    
    获取ID
    
    Specified by:
    
    getId in interface Node<T>
    
    Returns:
    
    ID
  - setId
```
public Tree<T> setId(T id)
```
    Description copied from interface: Node
    
    设置ID
    
    Specified by:
    
    setId in interface Node<T>
    
    Parameters:
    
    id - ID
    
    Returns:
    
    this
  - getParentId
```
public T getParentId()
```
    Description copied from interface: Node
    
    获取父节点ID
    
    Specified by:
    
    getParentId in interface Node<T>
    
    Returns:
    
    父节点ID
  - setParentId
```
public Tree<T> setParentId(T parentId)
```
    Description copied from interface: Node
    
    设置父节点ID
    
    Specified by:
    
    setParentId in interface Node<T>
    
    Parameters:
    
    parentId - 父节点ID
    
    Returns:
    
    this
  - getName
```
public CharSequence getName()
```
    Description copied from interface: Node
    
    获取节点标签名称
    
    Specified by:
    
    getName in interface Node<T>
    
    Returns:
    
    节点标签名称
  - setName
```
public Tree<T> setName(CharSequence name)
```
    Description copied from interface: Node
    
    设置节点标签名称
    
    Specified by:
    
    setName in interface Node<T>
    
    Parameters:
    
    name - 节点标签名称
    
    Returns:
    
    this
  - getWeight
```
public Comparable<?> getWeight()
```
    Description copied from interface: Node
    
    获取权重
    
    Specified by:
    
    getWeight in interface Node<T>
    
    Returns:
    
    权重
  - setWeight
```
public Tree<T> setWeight(Comparable<?> weight)
```
    Description copied from interface: Node
    
    设置权重
    
    Specified by:
    
    setWeight in interface Node<T>
    
    Parameters:
    
    weight - 权重
    
    Returns:
    
    this
  - getChildren
```
public List<Tree<T>> getChildren()
```
    获取所有子节点
    
    Returns:
    
    所有子节点
  - hasChild
```
public boolean hasChild()
```
    是否有子节点，无子节点则此为叶子节点
    
    Returns:
    
    是否有子节点
    
    Since:
    
    5.7.17
  - walk
```
public void walk(Consumer<Tree<T>> consumer)
```
    递归树并处理子树下的节点：
    
    Parameters:
    
    consumer - 节点处理器
    
    Since:
    
    5.7.16
  - filterNew
```
public Tree<T> filterNew(Filter<Tree<T>> filter)
```
    递归过滤并生成新的树
    通过Filter指定的过滤规则，本节点或子节点满足过滤条件，则保留当前节点，否则抛弃节点及其子节点
    
    Parameters:
    
    filter - 节点过滤规则函数，只需处理本级节点本身即可
    
    Returns:
    
    过滤后的节点，null 表示不满足过滤要求，丢弃之
    
    Since:
    
    5.7.17
    
    See Also:
    
    filter(Filter)
  - filter
```
public Tree<T> filter(Filter<Tree<T>> filter)
```
    递归过滤当前树，注意此方法会修改当前树
    通过Filter指定的过滤规则，本节点或子节点满足过滤条件，则保留当前节点及其所有子节点，否则抛弃节点及其子节点
    
    Parameters:
    
    filter - 节点过滤规则函数，只需处理本级节点本身即可
    
    Returns:
    
    过滤后的节点，null 表示不满足过滤要求，丢弃之
    
    Since:
    
    5.7.17
    
    See Also:
    
    filterNew(Filter)
  - setChildren
```
public Tree<T> setChildren(List<Tree<T>> children)
```
    设置子节点，设置后会覆盖所有原有子节点
    
    Parameters:
    
    children - 子节点列表，如果为null表示移除子节点
    
    Returns:
    
    this
  - addChildren
```
@SafeVarargs
public final Tree<T> addChildren(Tree<T>... children)
```
    增加子节点，同时关联子节点的父节点为当前节点
    
    Parameters:
    
    children - 子节点列表
    
    Returns:
    
    this
    
    Since:
    
    5.6.7
  - putExtra
```
public void putExtra(String key,
                     Object value)
```
    扩展属性
    
    Parameters:
    
    key - 键
    
    value - 扩展值
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class AbstractMap<String,Object>
  - cloneTree
```
public Tree<T> cloneTree()
```
    递归克隆当前节点（即克隆整个树，保留字段值）
    注意，此方法只会克隆节点，节点属性如果是引用类型，不会克隆
    
    Returns:
    
    新的节点
    
    Since:
    
    5.7.17

Class Tree<T>

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

Constructor Summary

Method Summary

Methods inherited from class java.util.LinkedHashMap

Methods inherited from class java.util.HashMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface cn.hutool.core.lang.tree.Node

Methods inherited from interface java.util.Map

Constructor Detail

Tree

Tree

Method Detail

getConfig

getParent

getNode

getParentsName

getParentsName

setParent

getId

setId

getParentId

setParentId

getName

setName

getWeight

setWeight

getChildren

hasChild

walk

filterNew

filter

setChildren

addChildren

putExtra

toString

cloneTree