Class FilePosition

  • All Implemented Interfaces:
    java.io.Serializable

    @API(status=STABLE,
         since="1.7")
    public class FilePosition
    extends java.lang.Object
    implements java.io.Serializable
    Position inside a file represented by line and column numbers.
    Since:
    1.7
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.Integer column  
      private int line  
      private static org.junit.platform.commons.logging.Logger logger  
      private static long serialVersionUID  
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private FilePosition​(int line)  
      private FilePosition​(int line, int column)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object o)  
      static FilePosition from​(int line)
      Create a new FilePosition using the supplied line number and an undefined column number.
      static FilePosition from​(int line, int column)
      Create a new FilePosition using the supplied line and column numbers.
      static java.util.Optional<FilePosition> fromQuery​(java.lang.String query)
      Create an optional FilePosition by parsing the supplied query string.
      java.util.Optional<java.lang.Integer> getColumn()
      Get the column number of this FilePosition, if available.
      int getLine()
      Get the line number of this FilePosition.
      int hashCode()  
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Field Detail

      • logger

        private static final org.junit.platform.commons.logging.Logger logger
      • line

        private final int line
      • column

        private final java.lang.Integer column
    • Constructor Detail

      • FilePosition

        private FilePosition​(int line)
      • FilePosition

        private FilePosition​(int line,
                             int column)
    • Method Detail

      • from

        public static FilePosition from​(int line)
        Create a new FilePosition using the supplied line number and an undefined column number.
        Parameters:
        line - the line number; must be greater than zero
        Returns:
        a FilePosition with the given line number
      • from

        public static FilePosition from​(int line,
                                        int column)
        Create a new FilePosition using the supplied line and column numbers.
        Parameters:
        line - the line number; must be greater than zero
        column - the column number; must be greater than zero
        Returns:
        a FilePosition with the given line and column numbers
      • fromQuery

        public static java.util.Optional<FilePosition> fromQuery​(java.lang.String query)
        Create an optional FilePosition by parsing the supplied query string.

        Examples of valid query strings:

        • "line=23"
        • "line=23&column=42"
        Parameters:
        query - the query string; may be null
        Returns:
        an Optional containing a FilePosition with the parsed line and column numbers; never null but potentially empty
        Since:
        1.3
        See Also:
        from(int), from(int, int)
      • getLine

        public int getLine()
        Get the line number of this FilePosition.
        Returns:
        the line number
      • getColumn

        public java.util.Optional<java.lang.Integer> getColumn()
        Get the column number of this FilePosition, if available.
        Returns:
        an Optional containing the column number; never null but potentially empty
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object