Class SourceSection

java.lang.Object
org.graalvm.polyglot.SourceSection
public final class SourceSection extends Object
Description of contiguous section of text within a Source of program code.; supports multiple modes of access to the text and its location. Two available source sections are considered equal if their sources, start and length are equal. Unavailable source sections are compared by identity. Source sections are designed to be used as keys in hash maps.
Since:
19.0

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    CharSequence
    getCharacters()
    Returns the source code fragment described by this section.
    int
    getCharEndIndex()
    Returns the index of the text position immediately following the last character in the section.
    int
    getCharIndex()
    Returns the 0-based index of the first character in this section.
    int
    getCharLength()
    Returns the length of this section in characters.
    CharSequence
    getCode()
    Deprecated.
    use getCharacters() instead.
    int
    getEndColumn()
    Returns the 1-based column number of the last character in this section (inclusive).
    int
    getEndLine()
    Returns 1-based line number of the last character in this section (inclusive).
    Source
    getSource()
    Representation of the source program that contains this section.
    int
    getStartColumn()
    Returns the 1-based column number of the first character in this section (inclusive).
    int
    getStartLine()
    Returns 1-based line number of the first character in this section (inclusive).
    boolean
    hasCharIndex()
    Returns true if this section has a character index information, false otherwise.
    boolean
    hasColumns()
    Returns true if this section has a column number information, false otherwise.
    int
    hashCode()
     
    boolean
    hasLines()
    Returns true if this section has a line number information, false otherwise.
    boolean
    isAvailable()
    Returns whether this is a special instance that signifies that source information is available.
    String
    toString()
    Returns an implementation-defined string representation of this source section to be used for debugging purposes only.

    Methods inherited from class Object

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

  • Method Details

    • isAvailable

      public boolean isAvailable()
      Returns whether this is a special instance that signifies that source information is available. Available source sections are never equal to unavailable source sections. Unavailable source sections return the same indices and lengths as empty source sections starting at character index 0.
      Since:
      19.0

    • hasLines

      public boolean hasLines()
      Returns true if this section has a line number information, false otherwise. When true, getStartLine() and getEndLine() return valid line numbers, when false, getStartLine() and getEndLine() return 1.
      Since:
      19.0

    • hasColumns

      public boolean hasColumns()
      Returns true if this section has a column number information, false otherwise. When true, hasLines() is true as well, getStartColumn() and getEndColumn() return valid column numbers. When false, getStartColumn() and getEndColumn() return 1.
      Since:
      19.0

    • hasCharIndex

      public boolean hasCharIndex()
      Returns true if this section has a character index information, false otherwise. When true, getCharIndex(), getCharEndIndex() and getCharLength() return valid character indices, when false, getCharIndex(), getCharEndIndex() and getCharLength() return 0.
      Since:
      19.0

    • getSource

      public Source getSource()
      Representation of the source program that contains this section.
      Returns:
      the source object.
      Since:
      19.0

    • getStartLine

      public int getStartLine()
      Returns 1-based line number of the first character in this section (inclusive). Returns 1 for out of bounds or unavailable source sections, or source sections not having lines.
      Returns:
      the starting line number.
      Since:
      19.0
      See Also:

    • getStartColumn

      public int getStartColumn()
      Returns the 1-based column number of the first character in this section (inclusive). Returns 1 for out of bounds or unavailable source sections, or source sections not having columns.
      Returns:
      the starting column number.
      Since:
      19.0
      See Also:

    • getEndLine

      public int getEndLine()
      Returns 1-based line number of the last character in this section (inclusive). Returns 1 for out of bounds or unavailable source sections, or source sections not having lines.
      Returns:
      the starting line number.
      Since:
      19.0
      See Also:

    • getEndColumn

      public int getEndColumn()
      Returns the 1-based column number of the last character in this section (inclusive). Returns 1 for out of bounds or unavailable source sections, or source sections not having columns.
      Returns:
      the starting column number.
      Since:
      19.0
      See Also:

    • getCharIndex

      public int getCharIndex()
      Returns the 0-based index of the first character in this section. Returns 0 for unavailable source sections, or sections not having character index. The returned index might be out of bounds of the source code if assertions (-ea) are not enabled.
      Returns:
      the starting character index.
      Since:
      19.0
      See Also:

    • getCharLength

      public int getCharLength()
      Returns the length of this section in characters. Returns 0 for unavailable source sections, or sections not having character index. The returned length might be out of bounds of the source code if assertions (-ea) are not enabled.
      Returns:
      the number of characters in the section.
      Since:
      19.0
      See Also:

    • getCharEndIndex

      public int getCharEndIndex()
      Returns the index of the text position immediately following the last character in the section. Returns 0 for unavailable source sections, or sections not having character index. The returned index might be out of bounds of the source code if assertions (-ea) are not enabled.
      Returns:
      the end position of the section.
      Since:
      19.0
      See Also:

    • getCode

      @Deprecated(since="19.0") public CharSequence getCode()
      Deprecated.
      use getCharacters() instead.
      Since:
      19.0

    • getCharacters

      public CharSequence getCharacters()
      Returns the source code fragment described by this section. Returns an empty string for out of bounds or unavailable source sections.
      Returns:
      the code as a string.
      Since:
      19.0

    • toString

      public String toString()
      Returns an implementation-defined string representation of this source section to be used for debugging purposes only.
      Overrides:
      toString in class Object
      Since:
      19.0
      See Also:

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
      Since:
      19.0 or earlier

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
      Since:
      19.0 or earlier