Scala Reflection Library 2.13.16 - scala.reflect.api.Mirror
Keywords: Scala Reflection Library 2.13.16 scala.reflect.api.Mirror

Scala Reflection Library2.13.16 < Back


# Packages

-  package root
  Definition Classes
    root
-  package scala
  Definition Classes
    root
-  package reflect
  Definition Classes
    scala
-  package api

  EXPERIMENTAL

  EXPERIMENTAL

  The Scala Reflection API (located in scala-reflect.jar).

  In Scala 2.10.0, the Scala Reflection API and its implementation have an "experimental" status. This means that the API and the docs are not complete and can be changed in binary- and source-incompatible manner in 2.10.1. This also means that the implementation has some known issues.

  The following types are the backbone of the Scala Reflection API, and serve as a good starting point for information about Scala Reflection:

  - scala.reflect.api.Symbols
  - scala.reflect.api.Types
  - scala.reflect.api.Mirrors
  - scala.reflect.api.Universe

  For more information about Scala Reflection, see the Reflection Guide

  Definition Classes
    reflect
- Annotations
- Constants
- Exprs
- FlagSets
- ImplicitTags
- Internals
- JavaUniverse
- Liftables
- Mirror
- Mirrors
- Names
- Position
- Positions
- Printers
- Quasiquotes
- Scopes
- StandardDefinitions
- StandardLiftables
- StandardNames
- Symbols
- TreeCreator
- Trees
- TypeCreator
- TypeTags
- Types
- Universe

c

scala.reflect.api

# Mirror

###

#### abstract class Mirror[U <: Universe with Singleton] extends AnyRef

EXPERIMENTAL

The base class for all mirrors.

See scala.reflect.api.Mirrors or Reflection Guide for a complete overview of `Mirror`s.

U

  the type of the universe this mirror belongs to.

Source
  Mirror.scala

Linear Supertypes
AnyRef, Any
Known Subclasses
JavaMirror, ReflectiveMirror, RuntimeMirror
Type Hierarchy

Ordering

1. Grouped
2. Alphabetic
3. By Inheritance

Inherited

1. Mirror
2. AnyRef
3. Any

Implicitly

1. by any2stringadd
2. by StringFormat
3. by Ensuring
4. by ArrowAssoc

1. Hide All
2. Show All

Visibility

1. Public
2. Protected

### Instance Constructors

1.  new Mirror()

### Abstract Value Members

1.  abstract def EmptyPackage: U.ModuleSymbol

   The module symbol of the default (unnamed) package

2.  abstract def EmptyPackageClass: U.ClassSymbol

   The module class symbol of the default (unnamed) package

3.  abstract def RootClass: U.ClassSymbol

   The class symbol of the `_root_` package

4.  abstract def RootPackage: U.ModuleSymbol

   The module symbol of the `_root_` package

5.  abstract def staticClass(fullName: String): U.ClassSymbol

   The symbol corresponding to the globally accessible class with the given fully qualified name `fullName`.

   The symbol corresponding to the globally accessible class with the given fully qualified name `fullName`.

   If the name points to a type alias, it's recursively dealiased and its target is returned. If you need a symbol that corresponds to the type alias itself, load it directly from the package class:

   scala> cm.staticClass("scala.List") res0: scala.reflect.runtime.universe.ClassSymbol = class List

   scala> res0.fullName res1: String = scala.collection.immutable.List

   scala> cm.staticPackage("scala") res2: scala.reflect.runtime.universe.ModuleSymbol = package scala

   scala> res2.moduleClass.info member TypeName("List") res3: scala.reflect.runtime.universe.Symbol = type List

   scala> res3.fullName res4: String = scala.List

   To be consistent with Scala name resolution rules, in case of ambiguity between a package and an object, the object is never been considered.

   For example for the following code:

   package foo { class B }

   object foo { class A class B }

   staticClass("foo.B") will resolve to the symbol corresponding to the class B declared in the package foo, and staticClass("foo.A") will throw a ScalaReflectionException.

   In the example above, to load a symbol that corresponds to the class B declared in the object foo, use staticModule("foo") to load the module symbol and then navigate info.members of its moduleClass.

6.  abstract def staticModule(fullName: String): U.ModuleSymbol

   The symbol corresponding to the globally accessible object with the given fully qualified name `fullName`.

   The symbol corresponding to the globally accessible object with the given fully qualified name `fullName`.

   To be consistent with Scala name resolution rules, in case of ambiguity between a package and an object, the object is never been considered.

   For example for the following code:

   package foo { object B }

   object foo { object A object B }

   staticModule("foo.B") will resolve to the symbol corresponding to the object B declared in the package foo, and staticModule("foo.A") will throw a ScalaReflectionException

   In the example above, to load a symbol that corresponds to the object B declared in the object foo, use staticModule("foo") to load the module symbol and then navigate info.members of its moduleClass.

7.  abstract def staticPackage(fullName: String): U.ModuleSymbol

   The symbol corresponding to a package with the given fully qualified name `fullName`.

8.  abstract def symbolOf[T](implicit arg0: U.WeakTypeTag[T]): U.TypeSymbol

   Type symbol of `x` as derived from a type tag.

9.  abstract val universe: U

   The universe this mirror belongs to.

### Concrete Value Members

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
2.  final def ##: Int
   Definition Classes
     AnyRef → Any
3.  def +(other: String): String
   Implicit
     This member is added by an implicit conversion from Mirror[U] toany2stringadd[Mirror[U]] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (Mirror[U], B)
   Implicit
     This member is added by an implicit conversion from Mirror[U] toArrowAssoc[Mirror[U]] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()
5.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
6.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
7.  def clone(): AnyRef
   Attributes
     protected[lang]
   Definition Classes
     AnyRef
   Annotations
     @throws(classOf[java.lang.CloneNotSupportedException]) @native()
8.  def ensuring(cond: (Mirror[U]) => Boolean, msg: => Any): Mirror[U]
   Implicit
     This member is added by an implicit conversion from Mirror[U] toEnsuring[Mirror[U]] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
9.  def ensuring(cond: (Mirror[U]) => Boolean): Mirror[U]
   Implicit
     This member is added by an implicit conversion from Mirror[U] toEnsuring[Mirror[U]] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
10.  def ensuring(cond: Boolean, msg: => Any): Mirror[U]
    Implicit
      This member is added by an implicit conversion from Mirror[U] toEnsuring[Mirror[U]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
11.  def ensuring(cond: Boolean): Mirror[U]
    Implicit
      This member is added by an implicit conversion from Mirror[U] toEnsuring[Mirror[U]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
12.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
13.  def equals(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef → Any
14.  def finalize(): Unit
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.Throwable])
15.  final def getClass(): Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
16.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
17.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
18.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
19.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
20.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
21.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
22.  def toString(): String
    Definition Classes
      AnyRef → Any
23.  def typeOf[T](implicit arg0: U.TypeTag[T]): U.Type

    Shortcut for `implicitly[TypeTag[T]].tpe`

24.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
25.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
26.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException]) @native()
27.  def weakTypeOf[T](implicit arg0: U.WeakTypeTag[T]): U.Type

    Shortcut for `implicitly[WeakTypeTag[T]].tpe`

### Deprecated Value Members

1.  def formatted(fmtstr: String): String
   Implicit
     This member is added by an implicit conversion from Mirror[U] toStringFormat[Mirror[U]] performed by method StringFormat in scala.Predef.
   Definition Classes
     StringFormat
   Annotations
     @deprecated @inline()
   Deprecated

     (Since version 2.12.16) Use `formatString.format(value)` instead of `value.formatted(formatString)`, or use the `f""` string interpolator. In Java 15 and later, `formatted` resolves to the new method in String which has reversed parameters.

2.  def →[B](y: B): (Mirror[U], B)
   Implicit
     This member is added by an implicit conversion from Mirror[U] toArrowAssoc[Mirror[U]] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @deprecated
   Deprecated

     (Since version 2.13.0) Use `->` instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd fromMirror[U] to any2stringadd[Mirror[U]]

### Inherited by implicit conversion StringFormat fromMirror[U] to StringFormat[Mirror[U]]

### Inherited by implicit conversion Ensuring fromMirror[U] to Ensuring[Mirror[U]]

### Inherited by implicit conversion ArrowAssoc fromMirror[U] to ArrowAssoc[Mirror[U]]

### Mirror

### TypeTags

### Ungrouped