Record Class SyTextLocationType.SyCharacter

java.lang.Object

java.lang.Record

com.io7m.jsycamore.api.text.SyTextLocationType.SyCharacter

Record Components:

isLeadingEdge - true if the location is at the leading edge of a character

centerIndex - The center index

centerCharacter - The character at the center index

insertionIndex - The insertion index

insertionCharacter - The character at the insertion index

Enclosing interface:

SyTextLocationType

public static record SyTextLocationType.SyCharacter(boolean isLeadingEdge, int centerIndex, char centerCharacter, int insertionIndex, char insertionCharacter)
extends Record

Information about a character at a location.

Constructor Summary

Constructors

Constructor	Description
SyCharacter(boolean isLeadingEdge, int centerIndex, char centerCharacter, int insertionIndex, char insertionCharacter)	Creates an instance of a SyCharacter record class.

Method Summary

Modifier and Type	Method	Description
char	centerCharacter()	Returns the value of the centerCharacter record component.
int	centerIndex()	Returns the value of the centerIndex record component.
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.
char	insertionCharacter()	Returns the value of the insertionCharacter record component.
int	insertionIndex()	Returns the value of the insertionIndex record component.
boolean	isLeadingEdge()	Returns the value of the isLeadingEdge record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

SyCharacter

public SyCharacter(boolean isLeadingEdge,
 int centerIndex,
 char centerCharacter,
 int insertionIndex,
 char insertionCharacter)

Creates an instance of a SyCharacter record class.

Parameters:

isLeadingEdge - the value for the isLeadingEdge record component

centerIndex - the value for the centerIndex record component

centerCharacter - the value for the centerCharacter record component

insertionIndex - the value for the insertionIndex record component

insertionCharacter - the value for the insertionCharacter record component

Method Details

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 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.

isLeadingEdge

public boolean isLeadingEdge()

Returns the value of the isLeadingEdge record component.

Returns:

the value of the isLeadingEdge record component

centerIndex

public int centerIndex()

Returns the value of the centerIndex record component.

Returns:

the value of the centerIndex record component

centerCharacter

public char centerCharacter()

Returns the value of the centerCharacter record component.

Returns:

the value of the centerCharacter record component

insertionIndex

public int insertionIndex()

Returns the value of the insertionIndex record component.

Returns:

the value of the insertionIndex record component

insertionCharacter

public char insertionCharacter()

Returns the value of the insertionCharacter record component.

Returns:

the value of the insertionCharacter record component