trait Position extends AnyRef

Position is the base trait for objects describing a position in a document.

It provides functionality for:

  • generating a visual representation of this position (longString);
  • comparing two positions (<).

To use this class for a concrete kind of document, implement the lineContents method.

Linear Supertypes
AnyRef, Any
Known Subclasses
NoPosition, OffsetPosition
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Position
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def column: Int

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

  2. abstract def line: Int

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

  3. abstract def lineContents: String

    The contents of the line at this position.

    The contents of the line at this position. (must not contain a new-line character).

    Attributes
    protected

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. 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 number or (in case of equal line numbers) column is smaller than the corresponding components of that

  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. 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)
             ^
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  17. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  18. 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
    Position → AnyRef → Any
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped