Package net.sourceforge.pmd.lang.document

Class TextPos2d

java.lang.Object
net.sourceforge.pmd.lang.document.TextPos2d
All Implemented Interfaces:
Comparable<TextPos2d>
public final class TextPos2d extends Object implements Comparable<TextPos2d>
A place in a text document, represented as line/column information.

Line and column are 1-based.

  • Method Details

    • getLine

      public int getLine()
      Returns the (1-based) line number.

    • getColumn

      public int getColumn()
      Returns the (1-based) column number.

    • pos2d

      public static TextPos2d pos2d(int line, int column)
      Builds a new region from offset and length.
      Throws:
      AssertionError - If either parameter is negative

    • compareTo

      public int compareTo(@NonNull TextPos2d that)
      Compares the start offset, then the length of a region.
      Specified by:
      compareTo in interface Comparable<TextPos2d>

    • toTupleString

      public String toTupleString()
      Returns a string looking like "(line=2, column=4)".

    • toDisplayStringInEnglish

      public String toDisplayStringInEnglish()
      Returns a string looking like "line 2, column 4").

    • toDisplayStringWithColon

      public String toDisplayStringWithColon()
      Returns a string looking like "2:4").

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object