Package ch.usi.si.seart.treesitter

Class TreeCursor

java.lang.Object

ch.usi.si.seart.treesitter.TreeCursor

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

OffsetTreeCursor

public class TreeCursor
extends Object

A tree cursor is a stateful object that allows you to walk a syntax tree with maximum efficiency.

Since:

1.0.0

Author:

Tommy MacWilliam, Ozren Dabić

Method Summary

Modifier and Type	Method	Description
void	close()	Delete the tree cursor, freeing all the memory that it used.
boolean	equals(Object obj)
String	getCurrentFieldName()
Node	getCurrentNode()
TreeCursorNode	getCurrentTreeCursorNode()
boolean	gotoFirstChild()	Move the cursor to the first child of its current node.
boolean	gotoNextSibling()	Move the cursor to the next sibling of its current node.
boolean	gotoParent()	Move the cursor to the parent of its current node.
int	hashCode()
boolean	isNull()
void	preorderTraversal(@NotNull Consumer<Node> callback)	Iteratively traverse over the parse tree, applying a callback to the nodes before they are visited.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

close

public void close()

Delete the tree cursor, freeing all the memory that it used.

Specified by:

close in interface AutoCloseable

getCurrentNode

public Node getCurrentNode()

Returns:

The tree cursor's current node

getCurrentFieldName

public String getCurrentFieldName()

Returns:

The field name of the tree cursor's current node, null if the current node doesn't have a field

getCurrentTreeCursorNode

public TreeCursorNode getCurrentTreeCursorNode()

Returns:

The tree cursor's current node

gotoFirstChild

public boolean gotoFirstChild()

Move the cursor to the first child of its current node.

Returns:

true if the cursor successfully moved, and false if there were no children

gotoNextSibling

public boolean gotoNextSibling()

Move the cursor to the next sibling of its current node.

Returns:

true if the cursor successfully moved, and false if there was no next sibling node

gotoParent

public boolean gotoParent()

Move the cursor to the parent of its current node.

Returns:

true if the cursor successfully moved, and false if there was no parent node (the cursor was already on the root node)

preorderTraversal

public void preorderTraversal(@NotNull
                              @NotNull Consumer<Node> callback)

Iteratively traverse over the parse tree, applying a callback to the nodes before they are visited.

Parameters:

callback - The callback consumer which will execute upon visiting a node

Throws:

NullPointerException - if callback is null

toString

public String toString()

Overrides:

toString in class Object

isNull

public final boolean isNull()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object