# Interface SyTextLocationType

All Superinterfaces:
  `Comparable<SyTextLocationType>`

public interface SyTextLocationType extends Comparable<SyTextLocationType>
A text location.

- ## Nested Class Summary

  Nested Classes
  Modifier and Type
  Interface
  Description
  `static final record`
  `SyTextLocationType.SyCaret`
  A caret.
  `static final record`
  `SyTextLocationType.SyCharacter`
  Information about a character at a location.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `SyTextLocationType.SyCaret`
  `caret()`
  `SyTextLocationType.SyCharacter`
  `characterAt()`
  `SyTextLineNumber`
  `lineNumber()`

  ### Methods inherited from interface Comparable

  `compareTo`

- ## Method Details

  - ### lineNumber

    SyTextLineNumber lineNumber()
    Returns:
      The line number of the text

  - ### characterAt

    SyTextLocationType.SyCharacter characterAt()
    Returns:
      The character at the location

  - ### caret

    SyTextLocationType.SyCaret caret()
    Returns:
      The caret for this location