Record Class TranscriptElementRange

java.lang.Object

java.lang.Record

ca.phon.session.position.TranscriptElementRange

Record Components:

transcriptElementIndex -

tier -

range -

public record TranscriptElementRange(int transcriptElementIndex, String tier, Range range)
extends Record

A range within a transcript element. The range is defined by a tier and a range of characters within that tier. If the transcript element is a record, tier will be the name of the specific tier. If the transcript element is a comment, the tier name will be the type of comment, if the transcript element is a gem, tier will be the type of gem.

Constructor Summary

Constructors

Constructor	Description
TranscriptElementRange(int transcriptElementIndex, String tier, Range range)	Creates an instance of a TranscriptElementRange record class.

Method Summary

Modifier and Type	Method	Description
TranscriptElementLocation	end()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
Range	range()	Returns the value of the range record component.
TranscriptElementLocation	start()
String	tier()	Returns the value of the tier record component.
final String	toString()	Returns a string representation of this record class.
int	transcriptElementIndex()	Returns the value of the transcriptElementIndex record component.

Methods inherited from class java.lang.Object

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

Constructor Details

TranscriptElementRange

public TranscriptElementRange(int transcriptElementIndex,
 String tier,
 Range range)

Creates an instance of a TranscriptElementRange record class.

Parameters:

transcriptElementIndex - the value for the transcriptElementIndex record component

tier - the value for the tier record component

range - the value for the range record component

Method Details

start

public TranscriptElementLocation start()

end

public TranscriptElementLocation end()

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

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.

transcriptElementIndex

public int transcriptElementIndex()

Returns the value of the transcriptElementIndex record component.

Returns:

the value of the transcriptElementIndex record component

tier

public String tier()

Returns the value of the tier record component.

Returns:

the value of the tier record component

range

public Range range()

Returns the value of the range record component.

Returns:

the value of the range record component