Scala Reflection Library 2.13.16 - scala.reflect.api.JavaUniverse.JavaMirror
Keywords: Scala Reflection Library 2.13.16 scala.reflect.api.JavaUniverse.JavaMirror

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
-  trait JavaUniverse extends Universe

  EXPERIMENTAL

  EXPERIMENTAL

  A refinement of scala.reflect.api.Universe for runtime reflection using JVM classloaders.

  This refinement equips mirrors with reflection capabilities for the JVM. `JavaMirror` can convert Scala reflection artifacts (symbols and types) into Java reflection artifacts (classes) and vice versa. It can also perform reflective invocations (getting/setting field values, calling methods, etc).

  See the Reflection Guide for details on how to use runtime reflection.

  Definition Classes
    api
- Alternative
- AlternativeApi
- AlternativeExtractor
- Annotated
- AnnotatedApi
- AnnotatedExtractor
- AnnotatedType
- AnnotatedTypeApi
- AnnotatedTypeExtractor
- Annotation
- AnnotationApi
- AnnotationExtractor
- AppliedTypeTree
- AppliedTypeTreeApi
- AppliedTypeTreeExtractor
- Apply
- ApplyApi
- ApplyExtractor
- Assign
- AssignApi
- AssignExtractor
- Bind
- BindApi
- BindExtractor
- Block
- BlockApi
- BlockExtractor
- BooleanFlag
- BoundedWildcardType
- BoundedWildcardTypeApi
- BoundedWildcardTypeExtractor
- CaseDef
- CaseDefApi
- CaseDefExtractor
- ClassDef
- ClassDefApi
- ClassDefExtractor
- ClassInfoType
- ClassInfoTypeApi
- ClassInfoTypeExtractor
- ClassMirror
- ClassSymbol
- ClassSymbolApi
- Compat
- CompatApi
- CompatToken
- CompoundType
- CompoundTypeApi
- CompoundTypeTree
- CompoundTypeTreeApi
- CompoundTypeTreeExtractor
- Constant
- ConstantApi
- ConstantExtractor
- ConstantType
- ConstantTypeApi
- ConstantTypeExtractor
- DefDef
- DefDefApi
- DefDefExtractor
- DefTree
- DefTreeApi
- DefinitionsApi
- ExistentialType
- ExistentialTypeApi
- ExistentialTypeExtractor
- ExistentialTypeTree
- ExistentialTypeTreeApi
- ExistentialTypeTreeExtractor
- Expr
- FieldMirror
- FlagOps
- FlagSet
- FlagValues
- FreeTermSymbol
- FreeTermSymbolApi
- FreeTypeSymbol
- FreeTypeSymbolApi
- Function
- FunctionApi
- FunctionExtractor
- GenericApply
- GenericApplyApi
- Ident
- IdentApi
- IdentExtractor
- If
- IfApi
- IfExtractor
- ImplDef
- ImplDefApi
- Import
- ImportApi
- ImportExtractor
- ImportSelector
- ImportSelectorApi
- ImportSelectorExtractor
- Importer
- InstanceMirror
- Internal
- InternalApi
- JavaArgument
- JavaArgumentApi
- JavaMirror
- LabelDef
- LabelDefApi
- LabelDefExtractor
- Liftable
- Literal
- LiteralApi
- LiteralExtractor
- Match
- MatchApi
- MatchExtractor
- MemberDef
- MemberDefApi
- MemberScope
- MemberScopeApi
- MethodMirror
- MethodSymbol
- MethodSymbolApi
- MethodType
- MethodTypeApi
- MethodTypeExtractor
- Mirror
- Modifiers
- ModifiersApi
- ModifiersExtractor
- ModuleDef
- ModuleDefApi
- ModuleDefExtractor
- ModuleMirror
- ModuleSymbol
- ModuleSymbolApi
- Name
- NameApi
- NameTree
- NameTreeApi
- NamedArg
- NamedArgApi
- NamedArgExtractor
- NamesApi
- New
- NewApi
- NewExtractor
- NullaryMethodType
- NullaryMethodTypeApi
- NullaryMethodTypeExtractor
- PackageDef
- PackageDefApi
- PackageDefExtractor
- PolyType
- PolyTypeApi
- PolyTypeExtractor
- Position
- Quasiquote
- RefTree
- RefTreeApi
- RefTreeExtractor
- ReferenceToBoxed
- ReferenceToBoxedApi
- ReferenceToBoxedExtractor
- RefinedType
- RefinedTypeApi
- RefinedTypeExtractor
- ReflectiveMirror
- ReificationSupportApi
- Return
- ReturnApi
- ReturnExtractor
- RuntimeClassApi
- RuntimeMirror
- Scope
- ScopeApi
- Select
- SelectApi
- SelectExtractor
- SelectFromTypeTree
- SelectFromTypeTreeApi
- SelectFromTypeTreeExtractor
- SingleType
- SingleTypeApi
- SingleTypeExtractor
- SingletonType
- SingletonTypeApi
- SingletonTypeTree
- SingletonTypeTreeApi
- SingletonTypeTreeExtractor
- StandardLiftableInstances
- StandardTypes
- StandardUnliftableInstances
- Star
- StarApi
- StarExtractor
- Super
- SuperApi
- SuperExtractor
- SuperType
- SuperTypeApi
- SuperTypeExtractor
- SymTree
- SymTreeApi
- Symbol
- SymbolApi
- Template
- TemplateApi
- TemplateExtractor
- TemplateMirror
- TermName
- TermNameApi
- TermNameExtractor
- TermNamesApi
- TermSymbol
- TermSymbolApi
- TermTree
- TermTreeApi
- This
- ThisApi
- ThisExtractor
- ThisType
- ThisTypeApi
- ThisTypeExtractor
- Throw
- ThrowApi
- ThrowExtractor
- Transformer
- Traverser
- Tree
- TreeApi
- TreeCopier
- TreeCopierOps
- TreePrinter
- Try
- TryApi
- TryExtractor
- TypTree
- TypTreeApi
- Type
- TypeApi
- TypeApply
- TypeApplyApi
- TypeApplyExtractor
- TypeBounds
- TypeBoundsApi
- TypeBoundsExtractor
- TypeBoundsTree
- TypeBoundsTreeApi
- TypeBoundsTreeExtractor
- TypeDef
- TypeDefApi
- TypeDefExtractor
- TypeName
- TypeNameApi
- TypeNameExtractor
- TypeNamesApi
- TypeRef
- TypeRefApi
- TypeRefExtractor
- TypeSymbol
- TypeSymbolApi
- TypeTag
- TypeTree
- TypeTreeApi
- TypeTreeExtractor
- Typed
- TypedApi
- TypedExtractor
- UnApply
- UnApplyApi
- UnApplyExtractor
- Unliftable
- ValDef
- ValDefApi
- ValDefExtractor
- ValOrDefDef
- ValOrDefDefApi
- WeakTypeTag

t

scala.reflect.api.JavaUniverse

# JavaMirror

###

#### trait JavaMirror extends api.Mirror[JavaUniverse.this.type] with RuntimeMirror

A refinement of scala.reflect.api.Mirror for runtime reflection using JVM classloaders.

With this upgrade, mirrors become capable of converting Scala reflection artifacts (symbols and types) into Java reflection artifacts (classes) and vice versa. Consequently, refined mirrors become capable of performing reflective invocations (getting/setting field values, calling methods, etc).

For more information about `Mirrors`s, see scala.reflect.api.Mirrors or the Reflection Guide: Mirrors

Source
  JavaUniverse.scala

Linear Supertypes
JavaUniverse.RuntimeMirror, JavaUniverse.ReflectiveMirror, api.Mirror[JavaUniverse.this.type], AnyRef, Any
Type Hierarchy

Ordering

1. Grouped
2. Alphabetic
3. By Inheritance

Inherited

1. JavaMirror
2. RuntimeMirror
3. ReflectiveMirror
4. Mirror
5. AnyRef
6. 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

### Abstract Value Members

1.  abstract def EmptyPackage: JavaUniverse.ModuleSymbol

   The module symbol of the default (unnamed) package

   The module symbol of the default (unnamed) package

   Definition Classes
     Mirror
2.  abstract def EmptyPackageClass: JavaUniverse.ClassSymbol

   The module class symbol of the default (unnamed) package

   The module class symbol of the default (unnamed) package

   Definition Classes
     Mirror
3.  abstract def RootClass: JavaUniverse.ClassSymbol

   The class symbol of the `_root_` package

   The class symbol of the `_root_` package

   Definition Classes
     Mirror
4.  abstract def RootPackage: JavaUniverse.ModuleSymbol

   The module symbol of the `_root_` package

   The module symbol of the `_root_` package

   Definition Classes
     Mirror
5.  abstract val classLoader: ClassLoader
6.  abstract def classSymbol(rtcls: RuntimeClass): JavaUniverse.ClassSymbol

   A class symbol for the specified runtime class.

   A class symbol for the specified runtime class.

   returns

     The class symbol for the runtime class in the current class loader.

   Definition Classes
     RuntimeMirror
   Exceptions thrown

     `java.lang.ClassNotFoundException` if no class with that name exists

     `scala.ScalaReflectionException` if no corresponding symbol exists to do: throws anything else?

7.  abstract def moduleSymbol(rtcls: RuntimeClass): JavaUniverse.ModuleSymbol

   A module symbol for the specified runtime class.

   A module symbol for the specified runtime class.

   returns

     The module symbol for the runtime class in the current class loader.

   Definition Classes
     RuntimeMirror
   Exceptions thrown

     `java.lang.ClassNotFoundException` if no class with that name exists

     `scala.ScalaReflectionException` if no corresponding symbol exists to do: throws anything else?

8.  abstract def reflect[T](obj: T)(implicit arg0: ClassTag[T]): JavaUniverse.InstanceMirror

   A reflective mirror for the given object.

   A reflective mirror for the given object.

   Such a mirror can be used to further reflect against the members of the object to get/set fields, invoke methods and inspect inner classes and objects.

   Definition Classes
     ReflectiveMirror
9.  abstract def reflectClass(cls: JavaUniverse.ClassSymbol): JavaUniverse.ClassMirror

   Reflects against a static 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 a static 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>.classSymbol(<runtime class loaded by its name>)`.

   The input symbol can be either private or non-private (Scala reflection transparently deals with visibility). It must be static, i.e. either top-level or nested within one or several static objects.

   Definition Classes
     ReflectiveMirror
10.  abstract def reflectModule(mod: JavaUniverse.ModuleSymbol): JavaUniverse.ModuleMirror

    Reflects against a static module symbol and returns a mirror that can be used to get the instance of the object or inspect its companion class.

    Reflects against a static 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 its companion class you would like to reflect, use `<this mirror>.classSymbol(<runtime class loaded by its name>).companion.get`.

    The input symbol can be either private or non-private (Scala reflection transparently deals with visibility). It must be static, i.e. either top-level or nested within one or several static objects.

    Definition Classes
      ReflectiveMirror
11.  abstract def runtimeClass(cls: JavaUniverse.ClassSymbol): RuntimeClass

    Maps a Scala class symbol to the corresponding Java class object

    Maps a Scala class symbol to the corresponding Java class object

    Definition Classes
      RuntimeMirror
    Exceptions thrown

      `java.lang.ClassNotFoundException` if there is no Java class corresponding to the given Scala class symbol. Note: If the Scala symbol is ArrayClass, a ClassNotFound exception is thrown because there is no unique Java class corresponding to a Scala generic array

12.  abstract def runtimeClass(tpe: JavaUniverse.Type): RuntimeClass

    Maps a Scala type to the corresponding Java class object

    Maps a Scala type to the corresponding Java class object

    Definition Classes
      RuntimeMirror
13.  abstract def staticClass(fullName: String): JavaUniverse.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.

    Definition Classes
      Mirror
14.  abstract def staticModule(fullName: String): JavaUniverse.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.

    Definition Classes
      Mirror
15.  abstract def staticPackage(fullName: String): JavaUniverse.ModuleSymbol

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

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

    Definition Classes
      Mirror
16.  abstract def symbolOf[T](implicit arg0: JavaUniverse.WeakTypeTag[T]): JavaUniverse.TypeSymbol

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

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

    Definition Classes
      Mirror
17.  abstract val universe: JavaUniverse.this.type

    The universe this mirror belongs to.

    The universe this mirror belongs to.

    Definition Classes
      Mirror

### 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 JavaMirror toany2stringadd[JavaMirror] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (JavaMirror, B)
   Implicit
     This member is added by an implicit conversion from JavaMirror toArrowAssoc[JavaMirror] 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: (JavaMirror) => Boolean, msg: => Any): JavaMirror
   Implicit
     This member is added by an implicit conversion from JavaMirror toEnsuring[JavaMirror] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
9.  def ensuring(cond: (JavaMirror) => Boolean): JavaMirror
   Implicit
     This member is added by an implicit conversion from JavaMirror toEnsuring[JavaMirror] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
10.  def ensuring(cond: Boolean, msg: => Any): JavaMirror
    Implicit
      This member is added by an implicit conversion from JavaMirror toEnsuring[JavaMirror] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
11.  def ensuring(cond: Boolean): JavaMirror
    Implicit
      This member is added by an implicit conversion from JavaMirror toEnsuring[JavaMirror] 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
      JavaMirror → AnyRef → Any
23.  def typeOf[T](implicit arg0: JavaUniverse.TypeTag[T]): JavaUniverse.Type

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

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

    Definition Classes
      Mirror
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: JavaUniverse.WeakTypeTag[T]): JavaUniverse.Type

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

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

    Definition Classes
      Mirror

### Deprecated Value Members

1.  def formatted(fmtstr: String): String
   Implicit
     This member is added by an implicit conversion from JavaMirror toStringFormat[JavaMirror] 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): (JavaMirror, B)
   Implicit
     This member is added by an implicit conversion from JavaMirror toArrowAssoc[JavaMirror] 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 JavaUniverse.RuntimeMirror

### Inherited from JavaUniverse.ReflectiveMirror

### Inherited from api.Mirror[JavaUniverse.this.type]

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd fromJavaMirror to any2stringadd[JavaMirror]

### Inherited by implicit conversion StringFormat fromJavaMirror to StringFormat[JavaMirror]

### Inherited by implicit conversion Ensuring fromJavaMirror to Ensuring[JavaMirror]

### Inherited by implicit conversion ArrowAssoc fromJavaMirror to ArrowAssoc[JavaMirror]

### Mirror

### TypeTags

### Ungrouped