OffsetTreeCursor (ch.usi.si.seart:java-tree-sitter 1.4.1 API)

java.lang.Object
- ch.usi.si.seart.treesitter.TreeCursor
- - ch.usi.si.seart.treesitter.OffsetTreeCursor

All Implemented Interfaces:

AutoCloseable
```
public class OffsetTreeCursor
extends TreeCursor
```
Specialization of TreeCursor that applies a positional offset to visited nodes. Retrieving nodes by either getCurrentNode() or getCurrentTreeCursorNode() applies the offset to a copy of the original node, meaning that the tree is not mutated during traversal.
So what exactly is the purpose of this cursor? Imagine a scenario in which we need to print out the node positions of a source code file that begins with n blank lines. Rather than modifying the original file, we can just use this cursor with a positional offset of new Position(-n, 0). Likewise, when printing node positions of an indented function, the n spaces of indentation can be negated with a positional offset of new Position(0, -n). Row and column offsets can be combined with various positive and negative arrangements.

Since:

1.2.0

Author:

Ozren Dabić

Constructor Summary

Constructors
Constructor Description

OffsetTreeCursor(Node node, Point offset)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object obj)`
`Node`	`getCurrentNode()`
`TreeCursorNode`	`getCurrentTreeCursorNode()`
`int`	`hashCode()`
`boolean`	`isNull()`

Methods inherited from class ch.usi.si.seart.treesitter.TreeCursor
close, getCurrentFieldName, gotoFirstChild, gotoNextSibling, gotoParent, preorderTraversal, toString

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

- Constructor Detail
  - OffsetTreeCursor
```
public OffsetTreeCursor(Node node,
                        Point offset)
```
- Method Detail
  - getCurrentNode
```
public Node getCurrentNode()
```
    Overrides:
    
    getCurrentNode in class TreeCursor
    
    Returns:
    
    The tree cursor's current node
  - getCurrentTreeCursorNode
```
public TreeCursorNode getCurrentTreeCursorNode()
```
    Overrides:
    
    getCurrentTreeCursorNode in class TreeCursor
    
    Returns:
    
    The tree cursor's current node
  - 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