case class OffsetPosition(source: CharSequence, offset: Int) extends Position with Product with Serializable

OffsetPosition is a standard class for positions represented as offsets into a source document.

source

The source document

offset

The offset indicating the position

Source
OffsetPosition.scala
Linear Supertypes
Serializable, java.io.Serializable, Product, Equals, Position, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OffsetPosition
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Position
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new OffsetPosition(source: CharSequence, offset: Int)

    source

    The source document

    offset

    The offset indicating the position

Value Members

  1. def <(that: Position): Boolean

    Compare this position to another, by first comparing their line numbers, and then -- if necessary -- using the columns to break a tie.

    Compare this position to another, by first comparing their line numbers, and then -- if necessary -- using the columns to break a tie.

    that

    a Position to compare to this Position

    returns

    true if this position's line number or (in case of equal line numbers) column is smaller than the corresponding components of that

    Definition Classes
    OffsetPosition → Position
  2. def column: Int

    The column number referred to by the position; column numbers start at 1.

    The column number referred to by the position; column numbers start at 1.

    Definition Classes
    OffsetPosition → Position
  3. def line: Int

    The line number referred to by the position; line numbers start at 1.

    The line number referred to by the position; line numbers start at 1.

    Definition Classes
    OffsetPosition → Position
  4. def lineContents: String

    The contents of the line numbered at the current offset.

    The contents of the line numbered at the current offset.

    returns

    the line at offset (not including a newline)

    Definition Classes
    OffsetPosition → Position
  5. def longString: String

    Returns a more visual representation of this position. More precisely, the resulting string consists of two lines:

    Returns a more visual representation of this position. More precisely, the resulting string consists of two lines:

    1. the line in the document referred to by this position 2. a caret indicating the column

    Example:

    List(this, is, a, line, from, the, document)
             ^
    Definition Classes
    Position
  6. val offset: Int
  7. val source: CharSequence
  8. def toString(): String

    Returns a string representation of the Position, of the form line.column.

    Returns a string representation of the Position, of the form line.column.

    Definition Classes
    OffsetPosition → Position → AnyRef → Any