figmagen-core/com.stuart.figmagen.tree/TreeNode

TreeNode

data class TreeNode<T> : Iterable<TreeNode<T>>

Constructors

TreeNode

fun <T> TreeNode(value: T)

Functions

addChild

fun addChild(child: T)

Add new child to current node or root.

child

fun child(child: T): TreeNode<T>

Add new child to current node or root.

clear

fun clear()

Remove all children from root and every node in tree.

depth

fun depth(): Int

Distance is the number of edges along the shortest path between two nodes.

forEach

open fun forEach(p0: Consumer<in TreeNode<T>>)

height

fun height(): Int

iterator

open operator override fun iterator(): Iterator<TreeNode<T>>

Tree is iterated by using `Pre-order Traversal Algorithm"

nodeCount

fun nodeCount(): Int

This function go through tree and counts children. Root element is not counted.

prettyString

fun prettyString(onPrint: (T) -> String? = null): String

removeChild

fun removeChild(child: TreeNode<T>): Boolean

Removes a single instance of the specified node from this tree, if it is present.

spliterator

open fun spliterator(): Spliterator<TreeNode<T>>

toString

open override fun toString(): String

Properties

children

val children: List<TreeNode<T>>

A group of nodes with the same parent.

parent

val parent: TreeNode<T>?

The converse notion of a child, an immediate ancestor.

root

val root: TreeNode<T>

value

val value: T

Extensions

node

fun <T> TreeNode<T>.node(value: T, builder: TreeNode<T>.() -> TreeNode<T>? = null): TreeNode<T>