Record Class FindResult

java.lang.Object

java.lang.Record

ca.phon.app.session.editor.search.FindResult

Record Components:

expr - the expression used to find the result

range - the range of the result within the transcript

matcher - the Java regex matcher for the result (may be null)

phonexMatcher - the Phonex matcher for the result (may be null)

public record FindResult(FindExpr expr, TranscriptElementRange range, Matcher matcher, PhonexMatcher phonexMatcher)
extends Record

Result of a find operation. This contains the expression used to find the result and the range of the result within the transcript.

Constructor Summary

Constructors

Constructor	Description
FindResult(FindExpr expr, TranscriptElementRange range, Matcher matcher, PhonexMatcher phonexMatcher)	Creates an instance of a FindResult record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
FindExpr	expr()	Returns the value of the expr record component.
final int	hashCode()	Returns a hash code value for this object.
boolean	isPhonexMatch()
boolean	isPlainMatch()
boolean	isRegexMatch()
Matcher	matcher()	Returns the value of the matcher record component.
PhonexMatcher	phonexMatcher()	Returns the value of the phonexMatcher record component.
TranscriptElementRange	range()	Returns the value of the range record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

FindResult

public FindResult(FindExpr expr,
 TranscriptElementRange range,
 Matcher matcher,
 PhonexMatcher phonexMatcher)

Creates an instance of a FindResult record class.

Parameters:

expr - the value for the expr record component

range - the value for the range record component

matcher - the value for the matcher record component

phonexMatcher - the value for the phonexMatcher record component

Method Details

isPlainMatch

public boolean isPlainMatch()

isRegexMatch

public boolean isRegexMatch()

isPhonexMatch

public boolean isPhonexMatch()

toString

public final 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. All components in this record class are compared with Objects::equals(Object,Object).

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.

expr

public FindExpr expr()

Returns the value of the expr record component.

Returns:

the value of the expr record component

range

public TranscriptElementRange range()

Returns the value of the range record component.

Returns:

the value of the range record component

matcher

public Matcher matcher()

Returns the value of the matcher record component.

Returns:

the value of the matcher record component

phonexMatcher

public PhonexMatcher phonexMatcher()

Returns the value of the phonexMatcher record component.

Returns:

the value of the phonexMatcher record component