Package io.jenkins.plugins.configsplice.engine

Record Class SourceRange

java.lang.Object
java.lang.Record
io.jenkins.plugins.configsplice.engine.SourceRange
Record Components:
start - inclusive start offset
end - exclusive end offset
All Implemented Interfaces:
Comparable<SourceRange>
public record SourceRange(int start, int end) extends Record implements Comparable<SourceRange>
A half-open [start, end) range of char offsets into a decoded document.

Offsets are char offsets rather than byte offsets deliberately. Both Jackson and StAX report positions against the character stream they were handed, so keeping one unit throughout removes an entire class of conversion bug. SourceDocument owns the single decode/encode boundary where characters become bytes again.

  • Constructor Summary

    Constructors
    Constructor
    Description
    SourceRange(int start, int end)
    Creates an instance of a SourceRange record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    compareTo(SourceRange other)
     
    int
    end()
    Returns the value of the end 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.
    int
    length()
     
    boolean
    overlaps(SourceRange other)
    Returns true if this range shares at least one character position with other.
    int
    start()
    Returns the value of the start record component.
    final 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

  • Constructor Details

    • SourceRange

      public SourceRange(int start, int end)
      Creates an instance of a SourceRange record class.
      Parameters:
      start - the value for the start record component
      end - the value for the end record component

  • Method Details

    • length

      public int length()

    • overlaps

      public boolean overlaps(SourceRange other)
      Returns true if this range shares at least one character position with other.

    • compareTo

      public int compareTo(SourceRange other)
      Specified by:
      compareTo in interface Comparable<SourceRange>

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

    • start

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

    • end

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