trait InstanceMirror extends AnyRef
A mirror that reflects a runtime value. See the overview page for details on how to use runtime reflection.
- Source
- Mirrors.scala
- Alphabetic
- By Inheritance
- InstanceMirror
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
instance: Any
The instance value reflected by this mirror
-
abstract
def
reflectClass(cls: Universe.ClassSymbol): Universe.ClassMirror
Reflects against an inner class symbol and returns a mirror that can be used to create instances of the class, inspect its companion object or perform further reflections.
Reflects against an inner class symbol and returns a mirror that can be used to create instances of the class, inspect its companion object or perform further reflections.
To get a class symbol by the name of the class you would like to reflect, use
<this mirror>.symbol.info.member(TypeName(<name of the class>)).asClass
. For further information about member lookup refer toSymbol.info
.The input symbol can be either private or non-private (Scala reflection transparently deals with visibility). It must be a member (declared or inherited) of the instance underlying this mirror.
-
abstract
def
reflectField(field: Universe.TermSymbol): Universe.FieldMirror
Reflects against a field symbol and returns a mirror that can be used to get and, if appropriate, set the value of the field.
Reflects against a field symbol and returns a mirror that can be used to get and, if appropriate, set the value of the field.
FieldMirrors are the only way to get at private[this] vals and vars and might be useful to inspect the data of underlying Java fields. For all other uses, it's better to go through the fields accessor.
In particular, there should be no need to ever access a field mirror when reflecting on just the public members of a class or trait. Note also that only accessor MethodMirrors, but not FieldMirrors will accurately reflect overriding behavior.
To get a field symbol by the name of the field you would like to reflect, use
<this mirror>.symbol.info.member(TermName(<name of the field>)).asTerm.accessed
. For further information about member lookup refer toSymbol.info
.The input symbol can be either private or non-private (Scala reflection transparently deals with visibility). It must be a member (declared or inherited) of the class of the instance underlying this mirror.
The input symbol can represent either a field itself or one of the corresponding accessors (in all cases the resulting mirror will refer to the field symbol).
If a field symbol doesn't correspond to a reflectable entity of the underlying platform, a
ScalaReflectionException
exception will be thrown. This might happen, for example, for primary constructor parameters. Typically they produce class fields, however, private parameters that aren't used outside the constructor remain plain parameters of a constructor method of the class. -
abstract
def
reflectMethod(method: Universe.MethodSymbol): Universe.MethodMirror
Reflects against a method symbol and returns a mirror that can be used to invoke the method provided.
Reflects against a method symbol and returns a mirror that can be used to invoke the method provided.
To get a method symbol by the name of the method you would like to reflect, use
<this mirror>.symbol.info.member(TermName(<name of the method>)).asMethod
. For further information about member lookup refer toSymbol.info
.The input symbol can be either private or non-private (Scala reflection transparently deals with visibility). It must be a member (declared or inherited) of the instance underlying this mirror.
-
abstract
def
reflectModule(mod: Universe.ModuleSymbol): Universe.ModuleMirror
Reflects against an inner module symbol and returns a mirror that can be used to get the instance of the object or inspect its companion class.
Reflects against an inner module symbol and returns a mirror that can be used to get the instance of the object or inspect its companion class.
To get a module symbol by the name of the object you would like to reflect, use
<this mirror>.symbol.info.member(TermName(<name of the object>)).asModule
. For further information about member lookup refer toSymbol.info
.The input symbol can be either private or non-private (Scala reflection transparently deals with visibility). It must be a member (declared or inherited) of the instance underlying this mirror.
-
abstract
def
symbol: Universe.ClassSymbol
The symbol corresponding to the runtime class of the reflected instance
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
Test two objects for inequality.
Test two objects for inequality.
- returns
true
if !(this == that), false otherwise.
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
Equivalent to
x.hashCode
except for boxed numeric types andnull
.Equivalent to
x.hashCode
except for boxed numeric types andnull
. 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. Fornull
returns a hashcode wherenull.hashCode
throws aNullPointerException
.- returns
a hash value consistent with ==
- Definition Classes
- AnyRef → Any
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from Universe.InstanceMirror to any2stringadd[Universe.InstanceMirror] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (Universe.InstanceMirror, B)
- Implicit
- This member is added by an implicit conversion from Universe.InstanceMirror to ArrowAssoc[Universe.InstanceMirror] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
-
final
def
==(arg0: Any): Boolean
The expression
x == that
is equivalent toif (x eq null) that eq null else x.equals(that)
.The expression
x == that
is equivalent toif (x eq null) that eq null else x.equals(that)
.- returns
true
if the receiver object is equivalent to the argument;false
otherwise.
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
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 aClassCastException
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 type.- returns
the receiver object.
- Definition Classes
- Any
- Exceptions thrown
ClassCastException
if the receiver object is not an instance of the erasure of typeT0
.
-
def
clone(): AnyRef
Create a copy of the receiver object.
Create 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[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
- Note
not specified by SLS as a member of AnyRef
-
def
ensuring(cond: (Universe.InstanceMirror) ⇒ Boolean, msg: ⇒ Any): Universe.InstanceMirror
- Implicit
- This member is added by an implicit conversion from Universe.InstanceMirror to Ensuring[Universe.InstanceMirror] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (Universe.InstanceMirror) ⇒ Boolean): Universe.InstanceMirror
- Implicit
- This member is added by an implicit conversion from Universe.InstanceMirror to Ensuring[Universe.InstanceMirror] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): Universe.InstanceMirror
- Implicit
- This member is added by an implicit conversion from Universe.InstanceMirror to Ensuring[Universe.InstanceMirror] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): Universe.InstanceMirror
- Implicit
- This member is added by an implicit conversion from Universe.InstanceMirror to Ensuring[Universe.InstanceMirror] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
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 ofAnyRef
, and has three additional properties:- It is consistent: for any non-null instances
x
andy
of typeAnyRef
, multiple invocations ofx.eq(y)
consistently returnstrue
or consistently returnsfalse
. - For any non-null instance
x
of typeAnyRef
,x.eq(null)
andnull.eq(x)
returnsfalse
. null.eq(null)
returnstrue
.
When overriding the
equals
orhashCode
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
).- returns
true
if the argument is a reference to the receiver object;false
otherwise.
- Definition Classes
- AnyRef
- It is consistent: for any non-null instances
-
def
equals(arg0: Any): Boolean
The equality method for reference types.
-
def
finalize(): Unit
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 betweenfinalize
and non-local returns and exceptions, are all platform dependent.- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- Note
not specified by SLS as a member of AnyRef
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from Universe.InstanceMirror to StringFormat[Universe.InstanceMirror] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
final
def
getClass(): Class[_]
Returns the runtime class representation of the object.
Returns the runtime class representation of the object.
- returns
a class object corresponding to the runtime type of the receiver.
- Definition Classes
- AnyRef → Any
-
def
hashCode(): Int
The hashCode method for reference types.
-
final
def
isInstanceOf[T0]: Boolean
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 returnfalse
, while the expressionList(1).isInstanceOf[List[String]]
will returntrue
. 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.- returns
true
if the receiver object is an instance of erasure of typeT0
;false
otherwise.
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
Equivalent to
!(this eq that)
.Equivalent to
!(this eq that)
.- returns
true
if the argument is not a reference to the receiver object;false
otherwise.
- Definition Classes
- AnyRef
-
final
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.
- Definition Classes
- AnyRef
- Note
not specified by SLS as a member of AnyRef
-
final
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.
- Definition Classes
- AnyRef
- Note
not specified by SLS as a member of AnyRef
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
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.
- returns
a String representation of the object.
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
→[B](y: B): (Universe.InstanceMirror, B)
- Implicit
- This member is added by an implicit conversion from Universe.InstanceMirror to ArrowAssoc[Universe.InstanceMirror] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc