Module org.elasticsearch.xcontent
Package org.elasticsearch.xcontent

Record Class XContentLocation

java.lang.Object
java.lang.Record
org.elasticsearch.xcontent.XContentLocation
public record XContentLocation(int lineNumber, int columnNumber, long byteOffset) extends Record
Simple data structure representing the line and column number of a position in some XContent e.g. JSON. Locations are typically used to communicate the position of a parsing error to end users and consequently have line and column numbers starting from 1.

The optional byteOffset field holds the absolute byte position within the source stream (-1 when not available). Byte offsets are used for programmatic byte-range slicing and are not included in the human-readable toString() output.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final XContentLocation
    UNKNOWN
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    XContentLocation(int lineNumber, int columnNumber)
    Backward-compatible constructor that sets byteOffset to -1 (not available).
    XContentLocation(int lineNumber, int columnNumber, long byteOffset)
    Creates an instance of a XContentLocation record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    byteOffset()
    Returns the value of the byteOffset record component.
    int
    columnNumber()
    Returns the value of the columnNumber 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.
    boolean
    hasValidByteOffset()
    Returns true if the byte offset is available (non-negative).
    boolean
    hasValidColumnNumber()
    Returns true if the column number is valid (1-based, so must be ≥ 1).
    boolean
    hasValidLineNumber()
    Returns true if the line number is valid (1-based, so must be ≥ 1).
    int
    lineNumber()
    Returns the value of the lineNumber record component.
    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

  • Field Details

  • Constructor Details

    • XContentLocation

      public XContentLocation(int lineNumber, int columnNumber)
      Backward-compatible constructor that sets byteOffset to -1 (not available).

    • XContentLocation

      public XContentLocation(int lineNumber, int columnNumber, long byteOffset)
      Creates an instance of a XContentLocation record class.
      Parameters:
      lineNumber - the value for the lineNumber record component
      columnNumber - the value for the columnNumber record component
      byteOffset - the value for the byteOffset record component

  • Method Details

    • hasValidLineNumber

      public boolean hasValidLineNumber()
      Returns true if the line number is valid (1-based, so must be ≥ 1).

    • hasValidColumnNumber

      public boolean hasValidColumnNumber()
      Returns true if the column number is valid (1-based, so must be ≥ 1).

    • hasValidByteOffset

      public boolean hasValidByteOffset()
      Returns true if the byte offset is available (non-negative).

    • toString

      public 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 '=='.
      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.

    • lineNumber

      public int lineNumber()
      Returns the value of the lineNumber record component.
      Returns:
      the value of the lineNumber record component

    • columnNumber

      public int columnNumber()
      Returns the value of the columnNumber record component.
      Returns:
      the value of the columnNumber record component

    • byteOffset

      public long byteOffset()
      Returns the value of the byteOffset record component.
      Returns:
      the value of the byteOffset record component