scala.util.parsing.input

OffsetPosition

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

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

source

The source document

offset

The offset indicating the position

go to: companion
linear super types: Product, Equals, Position, AnyRef, Any
source: OffsetPosition.scala
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. OffsetPosition
  2. Product
  3. Equals
  4. Position
  5. AnyRef
  6. Any
Visibility
  1. Public
  2. All
Impl.
  1. Concrete
  2. Abstract

Instance constructors

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

    source

    The source document

    offset

    The offset indicating the position

Value Members

  1. def != (arg0: AnyRef) : Boolean

    attributes: final
    definition classes: AnyRef
  2. def != (arg0: Any) : Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

    false if the receiver object is equivalent to the argument; true otherwise.

    attributes: final
    definition classes: Any
  3. def ## () : Int

    attributes: final
    definition classes: AnyRef → Any
  4. def $asInstanceOf [T0] () : T0

    attributes: final
    definition classes: AnyRef
  5. def $isInstanceOf [T0] () : Boolean

    attributes: final
    definition classes: AnyRef
  6. 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.

    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'

    definition classes: OffsetPositionPosition
  7. def == (arg0: AnyRef) : Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: AnyRef
  8. def == (arg0: Any) : Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    attributes: final
    definition classes: Any
  9. def asInstanceOf [T0] : T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  10. def canEqual (arg0: Any) : Boolean

    A method that should be called from every well-designed equals method that is open to be overridden in a subclass.

    A method that should be called from every well-designed equals method that is open to be overridden in a subclass. See Programming in Scala, Chapter 28 for discussion and design.

    definition classes: OffsetPositionEquals
  11. def clone () : AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    attributes: protected[lang]
    definition classes: AnyRef
  12. 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: OffsetPositionPosition
  13. def eq (arg0: AnyRef) : Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    arg0

    the object to compare against this object for reference equality.

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final
    definition classes: AnyRef
  14. def equals (arg0: Any) : Boolean

    The equality method defined in AnyRef.

    The equality method defined in AnyRef[email protected] true if the receiver object is equivalent to the argument; false otherwise. */

    definition classes: OffsetPositionEquals → AnyRef → Any
  15. def finalize () : Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected[lang]
    definition classes: AnyRef
  16. def getClass () : java.lang.Class[_ <: java.lang.Object]

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef
  17. def hashCode () : Int

    Returns a hash code value for the object.

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    returns

    the hash code value for the object.

    definition classes: OffsetPosition → AnyRef → Any
  18. def isInstanceOf [T0] : Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any
  19. 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: OffsetPositionPosition
  20. def lineContents : String

    The contents of the line numbered lnum' (must not contain a new-line character).

    The contents of the line numbered lnum' (must not contain a new-line character).

    returns

    the line at lnum' (not including a newline)

    definition classes: OffsetPositionPosition
  21. 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:

    • the line in the document referred to by this position
    • a caret indicating the column

    Example:

        List(this, is, a, line, from, the, document)
                     

    definition classes: Position
  22. def ne (arg0: AnyRef) : Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef
  23. def notify () : Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  24. def notifyAll () : Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    attributes: final
    definition classes: AnyRef
  25. val offset : Int

    The offset indicating the position

    The offset indicating the position

  26. def productArity : Int

    return k for a product A(x_1,...,x_k)

    return k for a product A(x_1,...,x_k)

    definition classes: OffsetPositionProduct
  27. def productElement (arg0: Int) : Any

    For a product A(x_1,...,x_k), returns x_(n+1) for 0 <= n < k

    For a product A(x_1,...,x_k), returns x_(n+1) for 0 <= n < k

    returns

    The element n elements after the first element

    definition classes: OffsetPositionProduct
  28. def productElements : Iterator[Any]

    definition classes: Product
      deprecated:
    1. use productIterator instead

  29. def productIterator : Iterator[Any]

    An iterator that returns all fields of this product

    An iterator that returns all fields of this product

    definition classes: Product
  30. def productPrefix : String

    By default the empty 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.

    definition classes: OffsetPositionProduct
  31. val source : CharSequence

    The source document

    The source document

  32. def synchronized [T0] (arg0: T0) : T0

    attributes: final
    definition classes: AnyRef
  33. def toString () : String

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

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

    definition classes: OffsetPositionPosition → AnyRef → Any
  34. def wait () : Unit

    attributes: final
    definition classes: AnyRef
  35. def wait (arg0: Long, arg1: Int) : Unit

    attributes: final
    definition classes: AnyRef
  36. def wait (arg0: Long) : Unit

    attributes: final
    definition classes: AnyRef

Inherited from Product

Inherited from Equals

Inherited from Position

Inherited from AnyRef

Inherited from Any