TreeBuilder/com.github.treeBuilder/TreeNode

TreeNode

data class TreeNode<T>(var name: String = "", var attributes: List<T> = listOf())

Parameters

name

name of a node

attributes

Attributes of a node, null by default

Constructors

TreeNode

constructor(name: String = "", attributes: List<T> = listOf())

Properties

attributes

var attributes: List<T>

childLowestIndex

var childLowestIndex: Int

children

var children: NodeList<T>

var depth: Int

var index: Int

var name: String

var parent: TreeNode<T>?

treeRef

lateinit var treeRef: Tree<T>

Functions

appendChild

fun appendChild(node: TreeNode<T>): TreeNode<T>

Add a new single TreeNode to this TreeNode

fun appendChild(name: String, attributes: List<T> = listOf()): TreeNode<T>

Add a new single TreeNode to this TreeNode.

appendChildren

@JvmName(name = "appendChildrenNodes")

fun appendChildren(children: NodeList<T>): TreeNode<T>

Add children nodes to this node, pass a NodeList

appendEmptyChildren

fun appendEmptyChildren(vararg names: String): TreeNode<T>

Add empty children nodes to this node, pass names

@JvmName(name = "appendChildrenNames")

fun appendEmptyChildren(names: List<String>): TreeNode<T>

Add empty children nodes to this node, pass a List with nodes' names

checkPath

fun checkPath(vararg path: Int): Int

fun checkPath(path: List<Int>): Int

Check if a path can be traversed from this node

clone

fun clone(): TreeNode<T>

Return a new independent instance of this TreeNode (deep copy), uses recursion

getAllBelow

fun <T> TreeNode<T>.getAllBelow(): NodeList<T>

Get all children nodes below the passed node, including this node.

getAllLeaves

fun <T> TreeNode<T>.getAllLeaves(): NodeList<T>

Get all leaves (nodes that have no children) from below this node.

getNodeOrNull

fun getNodeOrNull(vararg path: Int): TreeNode<T>?

Get a TreeNode at path starting from this node

getPath

fun getPath(): List<Int>

Get the path from root node to this node in a List, no recursion

getPathRec

fun getPathRec(): List<Int>

Get the path from root node to this node, uses recursion

getRoot

fun getRoot(): TreeNode<T>

Get the root node of the tree that this node belongs to.

getStringPath

fun <T> TreeNode<T>.getStringPath(vararg path: Int): String

Get String representation of a path from this node.

getStringPathFromRoot

fun <T> TreeNode<T>.getStringPathFromRoot(): String

Get a String representation of the path from the tree root to this node.

hasChildAt

fun hasChildAt(index: Int): Boolean

Check if this node has a child at the index

hasChildren

fun hasChildren(): Boolean

Check if this node has children

hasParent

fun hasParent(): Boolean

Check if this node has parent

isValidPath

fun isValidPath(vararg path: Int): Boolean

fun isValidPath(path: List<Int>): Boolean

setAttributes

fun setAttributes(vararg attributes: T): TreeNode<T>

Change/add attributes (as List) to this node. Create Tree with type T that you want your attributes to have.

setName

fun setName(name: String): TreeNode<T>

Change the name of this node.

tryGetNode

fun tryGetNode(vararg path: Int): TreeNode<T>

Get a TreeNode object located at a certain path in hierarchy, pass path as Int indices