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

java.lang.Object
- ch.usi.si.seart.treesitter.QueryCursor

All Implemented Interfaces:

AutoCloseable, Iterable<QueryMatch>
```
public class QueryCursor
extends Object
implements Iterable<QueryMatch>
```
Cursor used for executing queries, carrying the state needed to process them.
The query cursor should not be shared between threads, but can be reused for many query executions.

Since:

1.0.0

Author:

Ozren Dabić

Constructor Summary

Constructors
Constructor Description

QueryCursor(@NotNull Node node, @NotNull Query query)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`close()`	Delete the query cursor, freeing all the memory that it used.
`boolean`	`equals(Object obj)`
`void`	`execute()`	Start running a given query on a given node.
`int`	`hashCode()`
`boolean`	`isNull()`
`@NotNull Iterator<QueryMatch>`	`iterator()`
`QueryMatch`	`nextMatch()`	Advance to the next match of the currently running query.
`String`	`toString()`

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - QueryCursor
```
public QueryCursor(@NotNull
                   @NotNull Node node,
                   @NotNull
                   @NotNull Query query)
```
- Method Detail
  - close
```
public void close()
```
    Delete the query cursor, freeing all the memory that it used.
    
    Specified by:
    
    close in interface AutoCloseable
  - execute
```
public void execute()
```
    Start running a given query on a given node. Successive calls to this method are ignored.
  - nextMatch
```
public QueryMatch nextMatch()
```
    Advance to the next match of the currently running query.
    
    Returns:
    
    A match if there is one, null otherwise
    
    Throws:
    
    IllegalStateException - if queryExec() was not called beforehand
  - iterator
```
@NotNull
public @NotNull Iterator<QueryMatch> iterator()
```
    Specified by:
    
    iterator in interface Iterable<QueryMatch>
    
    Returns:
    
    An iterator over the query cursor matches, starting from the first match
  - 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