scala.reflect.api.Mirrors

# InstanceMirror

#### 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

Linear Supertypes
AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering

1. Alphabetic
2. By inheritance

Inherited

1. InstanceMirror
2. AnyRef
3. Any

Implicitly

1. by any2stringadd
2. by any2stringfmt
3. by any2ArrowAssoc
4. by any2Ensuring

1. Hide All
2. Show all

Learn more about member selection
Visibility

1. Public
2. All

### Abstract Value Members

1. #### abstract def instance: Any

   The instance value reflected by this mirror

2. #### 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.typeSignature.member(newTypeName(<name of the class>)).asClass`. For further information about member lookup refer to `Symbol.typeSignature`.

   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.

3. #### 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.typeSignature.member(newTermName(<name of the field>)).asTerm.accessed`. For further information about member lookup refer to `Symbol.typeSignature`.

   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.

4. #### 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.typeSignature.member(newTermName(<name of the method>)).asMethod`. For further information about member lookup refer to `Symbol.typeSignature`.

   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.

5. #### 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.typeSignature.member(newTermName(<name of the object>)).asModule`. For further information about member lookup refer to `Symbol.typeSignature`.

   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.

6. #### abstract def symbol: Universe.ClassSymbol

   The symbol corresponding to the runtime class of the reflected instance

### Concrete Value Members

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

   Definition Classes
     AnyRef

2. #### final def !=(arg0: Any): Boolean

   Test two objects for inequality.

   Test two objects for inequality.

   returns

     `true` if !(this == that), false otherwise.

   Definition Classes
     Any

3. #### final def ##(): Int

   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`.

   returns

     a hash value consistent with ==

   Definition Classes
     AnyRef → Any

4. #### def +(other: String): String

   Implicit information
     This member is added by an implicit conversion from Universe.InstanceMirror to StringAdd performed by method any2stringadd in scala.Predef.
   Definition Classes
     StringAdd

5. #### def ->[B](y: B): (Universe.InstanceMirror, B)

   Implicit information
     This member is added by an implicit conversion from Universe.InstanceMirror to ArrowAssoc[Universe.InstanceMirror] performed by method any2ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()

6. #### final def ==(arg0: AnyRef): Boolean

   Definition Classes
     AnyRef

7. #### final def ==(arg0: Any): Boolean

   Test two objects for equality.

   Test two objects for equality. The expression `x == that` is equivalent to `if (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
     Any

8. #### 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 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.

   returns

     the receiver object.

   Definition Classes
     Any
   Exceptions thrown
     ClassCastException

     if the receiver object is not an instance of the erasure of type `T0`.

9. #### 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

10. #### def ensuring(cond: (Universe.InstanceMirror) ⇒ Boolean, msg: ⇒ Any): Universe.InstanceMirror

    Implicit information
      This member is added by an implicit conversion from Universe.InstanceMirror to Ensuring[Universe.InstanceMirror] performed by method any2Ensuring in scala.Predef.
    Definition Classes
      Ensuring

11. #### def ensuring(cond: (Universe.InstanceMirror) ⇒ Boolean): Universe.InstanceMirror

    Implicit information
      This member is added by an implicit conversion from Universe.InstanceMirror to Ensuring[Universe.InstanceMirror] performed by method any2Ensuring in scala.Predef.
    Definition Classes
      Ensuring

12. #### def ensuring(cond: Boolean, msg: ⇒ Any): Universe.InstanceMirror

    Implicit information
      This member is added by an implicit conversion from Universe.InstanceMirror to Ensuring[Universe.InstanceMirror] performed by method any2Ensuring in scala.Predef.
    Definition Classes
      Ensuring

13. #### def ensuring(cond: Boolean): Universe.InstanceMirror

    Implicit information
      This member is added by an implicit conversion from Universe.InstanceMirror to Ensuring[Universe.InstanceMirror] performed by method any2Ensuring in scala.Predef.
    Definition Classes
      Ensuring

14. #### final def eq(arg0: AnyRef): Boolean

    Tests whether the argument (`arg0`) is a reference to the receiver object (`this`).

    Tests whether the argument (`arg0`) 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:

    - 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`).

    returns

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

    Definition Classes
      AnyRef

15. #### def equals(arg0: Any): Boolean

    The equality method for reference types.

    The equality method for reference types. Default implementation delegates to `eq`.

    See also `equals` in scala.Any.

    returns

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

    Definition Classes
      AnyRef → Any

16. #### 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 between `finalize` and non-local returns and exceptions, are all platform dependent.

    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws()
    Note

      not specified by SLS as a member of AnyRef

17. #### def formatted(fmtstr: String): String

    Returns string formatted according to given `format` string.

    Returns string formatted according to given `format` string. Format strings are as for `String.format` (@see java.lang.String.format).

    Implicit information
      This member is added by an implicit conversion from Universe.InstanceMirror to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
      StringFormat
    Annotations
      @inline()

18. #### final def getClass(): Class[_]

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

    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.

    Definition Classes
      AnyRef → Any
    Note

      not specified by SLS as a member of AnyRef

19. #### def hashCode(): Int

    The hashCode method for reference types.

    The hashCode method for reference types. See hashCode in scala.Any.

    returns

      the hash code value for this object.

    Definition Classes
      AnyRef → Any

20. #### 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 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.

    returns

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

    Definition Classes
      Any

21. #### 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

22. #### 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

23. #### 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

24. #### final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
      AnyRef

25. #### 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

26. #### final def wait(): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws()

27. #### final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws()

28. #### final def wait(arg0: Long): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws()

29. #### def →[B](y: B): (Universe.InstanceMirror, B)

    Implicit information
      This member is added by an implicit conversion from Universe.InstanceMirror to ArrowAssoc[Universe.InstanceMirror] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
      ArrowAssoc

### Shadowed Implict Value Members

1. #### val self: Any

   Implicit information
     This member is added by an implicit conversion from Universe.InstanceMirror to StringAdd performed by method any2stringadd in scala.Predef.
   Shadowing
     This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
     To access this member you can use a type ascription:

         (instanceMirror: StringAdd).self

   Definition Classes
     StringAdd

2. #### val self: Any

   Implicit information
     This member is added by an implicit conversion from Universe.InstanceMirror to StringFormat performed by method any2stringfmt in scala.Predef.
   Shadowing
     This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
     To access this member you can use a type ascription:

         (instanceMirror: StringFormat).self

   Definition Classes
     StringFormat

### Deprecated Value Members

1. #### def x: Universe.InstanceMirror

   Implicit information
     This member is added by an implicit conversion from Universe.InstanceMirror to ArrowAssoc[Universe.InstanceMirror] performed by method any2ArrowAssoc in scala.Predef.
   Shadowing
     This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
     To access this member you can use a type ascription:

         (instanceMirror: ArrowAssoc[Universe.InstanceMirror]).x

   Definition Classes
     ArrowAssoc
   Annotations
     @deprecated
   Deprecated

     (Since version 2.10.0) Use `leftOfArrow`instead``

2. #### def x: Universe.InstanceMirror

   Implicit information
     This member is added by an implicit conversion from Universe.InstanceMirror to Ensuring[Universe.InstanceMirror] performed by method any2Ensuring in scala.Predef.
   Shadowing
     This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
     To access this member you can use a type ascription:

         (instanceMirror: Ensuring[Universe.InstanceMirror]).x

   Definition Classes
     Ensuring
   Annotations
     @deprecated
   Deprecated

     (Since version 2.10.0) Use `resultOfEnsuring`instead``

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd from Universe.InstanceMirror to StringAdd

### Inherited by implicit conversion any2stringfmt from Universe.InstanceMirror to StringFormat

### Inherited by implicit conversion any2ArrowAssoc from Universe.InstanceMirror to ArrowAssoc[Universe.InstanceMirror]

### Inherited by implicit conversion any2Ensuring from Universe.InstanceMirror to Ensuring[Universe.InstanceMirror]

### Ungrouped