scala.util.parsing.input

class OffsetPosition

[source: scala/util/parsing/input/OffsetPosition.scala]

case class OffsetPosition(val source : java.lang.CharSequence, val offset : Int)
extends Position with Product

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

Parameters
source - The source document
offset - The offset indicating the position
Author
Martin Odersky
Method Summary
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.
def column : Int
The column number referred to by the position; column numbers start at 1
override def equals (arg0 : Any) : Boolean
override def hashCode : Int
def line : Int
The line number referred to by the position; line numbers start at 1
def lineContents : java.lang.String
The contents of the line numbered `lnum' (must not contain a new-line character).
override def productArity : Int
return k for a product A(x_1,...,x_k)
override def productElement (arg0 : Int) : Any
for a product A(x_1,...,x_k), returns x_(n+1) for 0 <= n < k
override def productPrefix : java.lang.String
By default the empty string. Implementations may override this method in order to prepend a string prefix to the result of the toString methods.
override def toString : java.lang.String
Returns a string representation of the `Position', of the form `line.column'
Methods inherited from Position
longString
Methods inherited from AnyRef
getClass, clone, notify, notifyAll, wait, wait, wait, finalize, ==, !=, eq, ne, synchronized
Methods inherited from Any
==, !=, isInstanceOf, asInstanceOf
Method Details
def line : Int
The line number referred to by the position; line numbers start at 1
Overrides
Position.line

def column : Int
The column number referred to by the position; column numbers start at 1
Overrides
Position.column

def lineContents : java.lang.String
The contents of the line numbered `lnum' (must not contain a new-line character).
Parameters
lnum - a 1-based integer index into the `document'
Returns
the line at `lnum' (not including a newline)
Overrides
Position.lineContents

override def toString : java.lang.String
Returns a string representation of the `Position', of the form `line.column'
Overrides
Position.toString

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.
Parameters
`that' - a `Position' to compare to this `Position'
Returns
true if this position's line or (in case of a tie wrt. line numbers) its column is smaller than the corresponding components of `that'
Overrides
Position.<

override def hashCode : Int

override def equals(arg0 : Any) : Boolean

override def productPrefix : java.lang.String
By default the empty string. Implementations may override this method in order to prepend a string prefix to the result of the toString methods.
Overrides
Product.productPrefix

override def productArity : Int
return k for a product A(x_1,...,x_k)
Overrides
Product.productArity

override def productElement(arg0 : Int) : Any
for a product A(x_1,...,x_k), returns x_(n+1) for 0 <= n < k
Parameters
n - the index of the element to return
Throws
IndexOutOfBoundsException -
Returns
The element n elements after the first element
Overrides
Product.productElement