The position type of this attachment
The position type of this attachment
The position indicates a column
and the line
in the source file.
The end of the position's range, or the point if not a range position.
If this is a range position, the offset position of its point.
If this is a range position, the offset position of its point. Otherwise the position itself
Is this position a non-transparent range position?
Is this position a range position?
Is this position a transparent position?
The position indicates a column
and the line
in the source file.
If opaque range, make this position transparent.
The point (where the ^ is) of the position, which is easiest to access using the line and column values. The line content is also available.
The underlying position
The underlying position
Java file corresponding to the source file of this position.
Java file corresponding to the source file of this position.
The return type is scala.reflect.io.AbstractFile
, which belongs to an experimental part of Scala reflection.
It should not be used unless you know what you are doing. In subsequent releases, this API will be refined
and exposed as a part of scala.reflect.api.
The start of the position's range, or the point if not a range position.
Returns a new position with the same attributes, but a different end value (if a range).
Returns a new position with the same attributes, but a different point value (if a range or offset).
Creates a copy of this attachment with the position replaced by newPos
Creates a copy of this attachment with the position replaced by newPos
Returns a new position with the same attributes, but a different start value (if a range).
The end of the position's range, or point if not a range position.
The end of the position's range, or point if not a range position.
(Since version 2.11.0) Removed from the public API
If this is a range position, the offset position of its end.
If this is a range position, the offset position of its end. Otherwise the position itself
(Since version 2.11.0) Removed from the public API
If this is a range position, the offset position of its start.
If this is a range position, the offset position of its start. Otherwise the position itself
(Since version 2.11.0) Removed from the public API
Does this position include the given position pos
?
This holds if this
is a range position and its range [start..end]
is the same or covers the range of the given position, which may or may not be a range position.
Does this position include the given position pos
?
This holds if this
is a range position and its range [start..end]
is the same or covers the range of the given position, which may or may not be a range position.
(Since version 2.11.0) Removed from the public API
Is this position not a NoPosition? If isDefined is true, offset and source are both defined.
Is this position not a NoPosition? If isDefined is true, offset and source are both defined.
(Since version 2.11.0) Removed from the public API
The content of the line this Position refers to.
The content of the line this Position refers to.
(Since version 2.11.0) Removed from the public API
Does this position overlap with that position? This holds if both positions are ranges and there is an interval of non-zero length that is shared by both position ranges.
Does this position overlap with that position? This holds if both positions are ranges and there is an interval of non-zero length that is shared by both position ranges.
(Since version 2.11.0) Removed from the public API
The point (where the ^ is) of the position, or else default
if undefined.
The point (where the ^ is) of the position, or else default
if undefined.
(Since version 2.11.0) Removed from the public API
Does this position precede that position? This holds if both positions are defined and the end point of this position is not larger than the start point of the given position.
Does this position precede that position? This holds if both positions are defined and the end point of this position is not larger than the start point of the given position.
(Since version 2.11.0) Removed from the public API
Does this position properly include the given position pos
("properly" meaning their
ranges are not the same)?
Does this position properly include the given position pos
("properly" meaning their
ranges are not the same)?
(Since version 2.11.0) Removed from the public API
Does this position properly precede the given position pos
("properly" meaning their ranges
do not share a common point).
Does this position properly precede the given position pos
("properly" meaning their ranges
do not share a common point).
(Since version 2.11.0) Removed from the public API
Does this position cover the same range as that position? Holds only if both position are ranges
Does this position cover the same range as that position? Holds only if both position are ranges
(Since version 2.11.0) Removed from the public API
Show a textual representation of the position.
Show a textual representation of the position.
(Since version 2.11.0) Use universe.show(position)
instead
The start of the position's range, or point if not a range position.
The start of the position's range, or point if not a range position.
(Since version 2.11.0) Removed from the public API
Convert this to a position around point
that spans a single source line
Convert this to a position around point
that spans a single source line
(Since version 2.11.0) Removed from the public API
If this is a range, the union with the other range, with the point of this position.
If this is a range, the union with the other range, with the point of this position. Otherwise, this position
(Since version 2.11.0) Removed from the public API
Test two objects for inequality.
Test two objects for inequality.
true
if !(this == that), false otherwise.
Equivalent to x.hashCode
except for boxed numeric types and null
.
Equivalent to x.hashCode
except for boxed numeric types and null
.
For numerics, it returns a hash value which is consistent
with value equality: if two value type instances compare
as true, then ## will produce the same hash value for each
of them.
For null
returns a hashcode where null.hashCode
throws a
NullPointerException
.
a hash value consistent with ==
The expression x == that
is equivalent to if (x eq null) that eq null else x.equals(that)
.
The expression x == that
is equivalent to if (x eq null) that eq null else x.equals(that)
.
true
if the receiver object is equivalent to the argument; false
otherwise.
The underlying payload with the guarantee that no two elements have the same type.
The underlying payload with the guarantee that no two elements have the same type.
Cast the receiver object to be of type T0
.
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 expression 1.asInstanceOf[String]
will throw a ClassCastException
at
runtime, while the expression List(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 type.
the receiver object.
ClassCastException
if the receiver object is not an instance of the erasure of type T0
.
Create a copy of the receiver object.
Create a copy of the receiver object.
The default implementation of the clone
method is platform dependent.
a copy of the receiver object.
not specified by SLS as a member of AnyRef
Check underlying payload contains an instance of type T
.
Check underlying payload contains an instance of type T
.
Tests whether the argument (that
) is a reference to the receiver object (this
).
Tests whether the argument (that
) is a reference to the receiver object (this
).
The eq
method implements an equivalence relation on
non-null instances of AnyRef
, and has three additional properties:
x
and y
of type AnyRef
, multiple invocations of
x.eq(y)
consistently returns true
or consistently returns false
.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
).
true
if the argument is a reference to the receiver object; false
otherwise.
The equality method for reference types.
Called by the garbage collector on the receiver object when there are no more references to the object.
Called by the garbage collector on the receiver object when there are no more references to the object.
The details of when and if the finalize
method is invoked, as
well as the interaction between finalize
and non-local returns
and exceptions, are all platform dependent.
not specified by SLS as a member of AnyRef
An underlying payload of the given class type T
.
An underlying payload of the given class type T
.
Returns the runtime class representation of the object.
Returns the runtime class representation of the object.
a class object corresponding to the runtime type of the receiver.
The hashCode method for reference types.
Test whether the dynamic type of the receiver object is T0
.
Test whether the dynamic type of the receiver object is T0
.
Note that the result of the test is modulo Scala's erasure semantics.
Therefore the expression 1.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 specified type.
true
if the receiver object is an instance of erasure of type T0
; false
otherwise.
Equivalent to !(this eq that)
.
Equivalent to !(this eq that)
.
true
if the argument is not a reference to the receiver object; false
otherwise.
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.
not specified by SLS as a member of AnyRef
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.
not specified by SLS as a member of AnyRef
Creates a copy of this attachment with the payload of the given class type T
removed.
Creates a copy of this attachment with the payload of the given class type T
removed.
Creates a String representation of this object.
Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.
a String representation of the object.
Creates a copy of this attachment with the payload slot of T added/updated with the provided value.
Creates a copy of this attachment with the payload slot of T added/updated with the provided value. Replaces an existing payload of the same type, if exists.
EXPERIMENTAL
Position tracks the origin of symbols and tree nodes. They are commonly used when displaying warnings and errors, to indicate the incorrect point in the program.
Every non-empty position refers to a SourceFile and three character offsets within it: start, end, and point. The point is where the ^ belongs when issuing an error message, usually a Name. A range position can be designated as transparent, which excuses it from maintaining the invariants to follow. If a transparent position has opaque children, those are considered as if they were the direct children of the transparent position's parent.
Note: some of these invariants actually apply to the trees which carry the positions, but they are phrased as if the positions themselves were the parent/children for conciseness.
Invariant 1: in a focused/offset position, start == point == end Invariant 2: in a range position, start <= point < end Invariant 3: an offset position never has a child with a range position Invariant 4: every range position child of a range position parent is contained within its parent Invariant 5: opaque range position siblings overlap at most at a single point
The following tests are useful on positions:
pos.isDefined true if position is not an UndefinedPosition (those being NoPosition and FakePos) pos.isRange true if position is a range (opaque or transparent) which implies start < end pos.isOpaqueRange true if position is an opaque range
The following accessor methods are provided - an exception will be thrown if point/start/end are attempted on an UndefinedPosition.
pos.source The source file of the position, or NoSourceFile if unavailable pos.point The offset of the point pos.start The (inclusive) start offset, or the point of an offset position pos.end The (exclusive) end offset, or the point of an offset position
The following conversion methods are often used:
pos.focus Converts a range position to an offset position focused on the point pos.makeTransparent Convert an opaque range into a transparent range
For more information about
Position
s, see the Reflection Guide: Annotations, Names, Scopes, and More