Package de.firemage.autograder.span

Record Class Span

java.lang.Object
java.lang.Record
de.firemage.autograder.span.Span
Record Components:
start - the start of the span (inclusive)
end - the end of the span (exclusive)
public record Span(Position start, Position end) extends Record
A span of text in a file.

  • Constructor Details

    • Span

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

  • Method Details

    • of

      public static Span of(int lineNumber, String string)
      Creates a span which covers the entire string.
      Parameters:
      lineNumber - the line number where the string starts (0-indexed)
      string - the string to span
      Returns:
      a span which covers the entire string

    • isInline

      public boolean isInline()

    • includesLine

      public boolean includesLine(int lineNumber)

    • isEmpty

      public boolean isEmpty()

    • isFollowedBy

      public boolean isFollowedBy(Span other)

    • contains

      public boolean contains(Span span)

    • relativize

      public Span relativize(Span span)
      Makes the given span relative to this span.
      Parameters:
      span - the span to relativize, must be contained in this span
      Returns:
      the relative span

    • intersection

      public Optional<Span> intersection(Span other)

    • relativeIntersection

      public Span relativeIntersection(Span other)

    • 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 Objects::equals(Object,Object).
      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 Position start()
      Returns the value of the start record component.
      Returns:
      the value of the start record component

    • end

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