Tree

class Tree<T>

Set T to the type of attributes that you want to attach to a node For example: TreeNode has its attributes in List

Constructors

Tree

constructor()

constructor(root: TreeNode<T>)

constructor(treeName: String)

Types

Companion

object Companion

Properties

cursorIsAtRoot

val cursorIsAtRoot: Boolean

cursorNode

val cursorNode: TreeNode<T>

Get the node located at the current cursor

cursorPath

var cursorPath: List<Int>

root

var root: TreeNode<T>

The root cannot be reassigned from outside the lib, but its properties can be changed (besides treeRef)

treeName

var treeName: String

Functions

appendEmptyNamedToPaths

fun appendEmptyNamedToPaths(vararg namesPathPair: Pair<List<String>, List<Int>>): Int

appendEmptyNamedToPathsStrict

fun appendEmptyNamedToPathsStrict(vararg namesPathPair: Pair<List<String>, List<Int>>): Boolean

appendNode

fun appendNode(node: TreeNode<T>, vararg path: Int): Boolean

Append a node to a path from root

appendNodes

fun appendNodes(nodes: NodeList<T>, vararg path: Int): Boolean

checkPath

fun checkPath(vararg path: Int): Int

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

Check if the path starting from root corresponds to a node

clone

fun clone(): Tree<T>

Use to make an independent instance of this tree (deep copy)

cursorAppendEmptyNodes

fun cursorAppendEmptyNodes(vararg names: String): Tree<T>

Append empty named nodes to the node at the cursor

cursorAppendNode

fun cursorAppendNode(node: TreeNode<T>): Tree<T>

fun cursorAppendNode(name: String, attributes: List<T> = listOf()): Tree<T>

Append a node to the node at the cursor

cursorAppendNodes

fun cursorAppendNodes(nodes: NodeList<T>): Tree<T>

Append nodes to the node at the cursor

cursorCheckMoveUp

fun cursorCheckMoveUp(n: Int): Boolean

Check if able to move the cursor up, up to n times.

cursorMoveToRoot

fun cursorMoveToRoot(): Tree<T>

cursorMoveUp

fun cursorMoveUp(): Boolean

Move your current position to parent node, if no parent exists, remain at the same place

fun cursorMoveUp(n: Int): Tree<T>

Move the cursor up n times, stop when the

cursorSet

fun cursorSet(vararg path: Int): Tree<T>

Update your current position to a route from root, if no such path, remain at the same place

cursorSetRelative

fun cursorSetRelative(vararg path: Int): Tree<T>

Set cursor relatively from current position. Remain at the same place if the path does not exist.

cursorSetWithResult

fun cursorSetWithResult(vararg path: Int): Int

Update your current position to a route from root, if no such path, remain at the same place

getAllLeaves

fun getAllLeaves(): NodeList<T>

Get all leaves (nodes that have no children) from this tree

getAllNodes

fun getAllNodes(): NodeList<T>

Get all nodes in the tree. The nodes in the list are sorted deep to shallow and right to left

getNodeOrNull

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

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

Get TreeNode at the certain path from root.

getStringPath

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

Get String representation of a path from the tree root.

isValidPath

fun isValidPath(vararg path: Int): Boolean

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

Check if this path from root is valid.

printLeavesWithDepth

fun <T> Tree<T>.printLeavesWithDepth()

Prints out all leaves, each shifted by 20 * depth

setRootAttributes

fun setRootAttributes(attributes: List<T>): Tree<T>

Made for convenience and chaining. Direct tree.root.attributes = someList() is still possible.

setRootName

fun setRootName(name: String): Tree<T>

Made for convenience and chaining. Direct tree.root.name = "someName" is still possible.

visualizeTree

fun <T> Tree<T>.visualizeTree()

Get a visualization of the whole tree.