Package io.github.treesitter.jtreesitter

Record Class QueryMatch

java.lang.Object

java.lang.Record

io.github.treesitter.jtreesitter.QueryMatch

@NullMarked
public record QueryMatch(int patternIndex, List<QueryCapture> captures)
extends Record

A match that corresponds to a certain pattern in the query.

Constructor Summary

Constructors

Constructor	Description
QueryMatch(int patternIndex, List<QueryCapture> captures)	Creates an instance of a QueryMatch record class.

Method Summary

Modifier and Type	Method	Description
List<QueryCapture>	captures()	Returns the value of the captures record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
List<Node>	findNodes(String capture)	Find the nodes that are captured by the given capture name.
final int	hashCode()	Returns a hash code value for this object.
int	patternIndex()	Returns the value of the patternIndex record component.
String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

QueryMatch

public QueryMatch(@Unsigned
 int patternIndex,
 List<QueryCapture> captures)

Creates an instance of a QueryMatch record class.

Method Details

findNodes

public List<Node> findNodes(String capture)

Find the nodes that are captured by the given capture name.

toString

public String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

patternIndex

@Unsigned
public int patternIndex()

Returns the value of the patternIndex record component.

Returns:

the value of the patternIndex record component

captures

public List<QueryCapture> captures()

Returns the value of the captures record component.

Returns:

the value of the captures record component