OffsetPosition

scala.util.parsing.input.OffsetPosition
See theOffsetPosition companion object
case class OffsetPosition(source: CharSequence, offset: Int) extends Position

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

Value parameters

offset

The offset indicating the position

source

The source document

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Position
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

override 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.

Value parameters

that

a Position to compare to this Position

Attributes

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
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.

Attributes

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.

Attributes

The contents of the line numbered at the current offset.

The contents of the line numbered at the current offset.

Attributes

Returns

the line at offset (not including a newline)

override 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.

Attributes

Definition Classes
Position -> Any

Inherited methods

override def equals(other: Any): Boolean

Compare this position to another, checking for equality.

Compare this position to another, checking for equality.

Value parameters

`that`

a Position to compare to this Position

Attributes

Returns

true if the line numbers and column numbers are equal.

Definition Classes
Position -> Any
Inherited from:
Position
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)
               ^

Attributes

Inherited from:
Position

Attributes

Inherited from:
Product

Attributes

Inherited from:
Product