Scala Reflection Library 2.13.16 - scala.reflect.api.Internals.InternalApi.DecoratorApi.SymbolDecoratorApi
Keywords: Scala Reflection Library 2.13.16 scala.reflect.api.Internals.InternalApi.DecoratorApi.SymbolDecoratorApi

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 Internals extends AnyRef

  EXPERIMENTAL

  EXPERIMENTAL

  This trait assembles APIs occasionally necessary for performing low-level operations on reflection artifacts. See Internals#InternalApi for more information about nature, usefulness and compatibility guarantees of these APIs.

  Definition Classes
    api
-  trait InternalApi extends AnyRef

  Reflection API exhibits a tension inherent to experimental things: on the one hand we want it to grow into a beautiful and robust API, but on the other hand we have to deal with immaturity of underlying mechanisms by providing not very pretty solutions to enable important use cases.

  Reflection API exhibits a tension inherent to experimental things: on the one hand we want it to grow into a beautiful and robust API, but on the other hand we have to deal with immaturity of underlying mechanisms by providing not very pretty solutions to enable important use cases.

  In Scala 2.10, which was our first stab at reflection API, we didn't have a systematic approach to dealing with this tension, sometimes exposing too much of internals (e.g. Symbol.deSkolemize) and sometimes exposing too little (e.g. there's still no facility to change owners, to do typing transformations, etc). This resulted in certain confusion with some internal APIs living among public ones, scaring the newcomers, and some internal APIs only available via casting, which requires intimate knowledge of the compiler and breaks compatibility guarantees.

  This led to creation of the `internal` API module for the reflection API, which provides advanced APIs necessary for macros that push boundaries of the state of the art, clearly demarcating them from the more or less straightforward rest and providing compatibility guarantees on par with the rest of the reflection API (full compatibility within minor releases, best effort towards backward compatibility within major releases, clear replacement path in case of rare incompatible changes in major releases).

  The `internal` module itself (the value that implements InternalApi) isn't defined here, in scala.reflect.api.Universe, but is provided on per-implementation basis. Runtime API endpoint (scala.reflect.runtime.universe) provides `universe.compat: InternalApi`, whereas compile-time API endpoints (instances of scala.reflect.macros.Context) provide `c.compat: ContextInternalApi`, which extends `InternalApi` with additional universe-specific and context-specific functionality.

  Definition Classes
    Internals
-  trait DecoratorApi extends AnyRef

  Definition Classes
    InternalApi
  See also

    Decorators

- SymbolDecorator
- SymbolDecoratorApi
- TreeDecorator
- TreeDecoratorApi
- TypeDecorator
- TypeDecoratorApi

c

scala.reflect.api.Internals.InternalApi.DecoratorApi

# SymbolDecoratorApi

###

#### class SymbolDecoratorApi[T <: Universe.Symbol] extends AnyRef

Source
  Internals.scala
See also

  SymbolDecorator

Linear Supertypes
AnyRef, Any
Known Subclasses
MacroSymbolDecoratorApi
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. SymbolDecoratorApi
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 SymbolDecoratorApi(symbol: T)

### 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 SymbolDecoratorApi[T] toany2stringadd[SymbolDecoratorApi[T]] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (SymbolDecoratorApi[T], B)
   Implicit
     This member is added by an implicit conversion from SymbolDecoratorApi[T] toArrowAssoc[SymbolDecoratorApi[T]] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()
5.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
6.  def asFreeTerm: Universe.FreeTermSymbol

   See also

     InternalApi.asFreeTerm

7.  def asFreeType: Universe.FreeTypeSymbol

   See also

     InternalApi.asFreeType

8.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
9.  def clone(): AnyRef
   Attributes
     protected[lang]
   Definition Classes
     AnyRef
   Annotations
     @throws(classOf[java.lang.CloneNotSupportedException]) @native()
10.  def deSkolemize: Universe.Symbol

    See also

      InternalApi.deSkolemize

11.  def ensuring(cond: (SymbolDecoratorApi[T]) => Boolean, msg: => Any): SymbolDecoratorApi[T]
    Implicit
      This member is added by an implicit conversion from SymbolDecoratorApi[T] toEnsuring[SymbolDecoratorApi[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
12.  def ensuring(cond: (SymbolDecoratorApi[T]) => Boolean): SymbolDecoratorApi[T]
    Implicit
      This member is added by an implicit conversion from SymbolDecoratorApi[T] toEnsuring[SymbolDecoratorApi[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
13.  def ensuring(cond: Boolean, msg: => Any): SymbolDecoratorApi[T]
    Implicit
      This member is added by an implicit conversion from SymbolDecoratorApi[T] toEnsuring[SymbolDecoratorApi[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
14.  def ensuring(cond: Boolean): SymbolDecoratorApi[T]
    Implicit
      This member is added by an implicit conversion from SymbolDecoratorApi[T] toEnsuring[SymbolDecoratorApi[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
15.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
16.  def equals(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef → Any
17.  def finalize(): Unit
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.Throwable])
18.  def flags: Universe.FlagSet

    See also

      InternalApi.flags

19.  def fullyInitialize: T

    See also

      InternalApi.fullyInitialize

20.  final def getClass(): Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
21.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
22.  def initialize: T

    See also

      InternalApi.initialize

23.  def isErroneous: Boolean

    See also

      InternalApi.isErroneous

24.  def isFreeTerm: Boolean

    See also

      InternalApi.isFreeTerm

25.  def isFreeType: Boolean

    See also

      InternalApi.isFreeType

26.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
27.  def isSkolem: Boolean

    See also

      InternalApi.isSkolem

28.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
29.  def newClassSymbol(name: Universe.TypeName, pos: Universe.Position = NoPosition, flags: Universe.FlagSet = NoFlags): Universe.ClassSymbol

    See also

      InternalApi.newClassSymbol

30.  def newMethodSymbol(name: Universe.TermName, pos: Universe.Position = NoPosition, flags: Universe.FlagSet = NoFlags): Universe.MethodSymbol

    See also

      InternalApi.newMethodSymbol

31.  def newModuleAndClassSymbol(name: Universe.Name, pos: Universe.Position = NoPosition, flags: Universe.FlagSet = NoFlags): (Universe.ModuleSymbol, Universe.ClassSymbol)

    See also

      InternalApi.newModuleAndClassSymbol

32.  def newTermSymbol(name: Universe.TermName, pos: Universe.Position = NoPosition, flags: Universe.FlagSet = NoFlags): Universe.TermSymbol

    See also

      InternalApi.newTermSymbol

33.  def newTypeSymbol(name: Universe.TypeName, pos: Universe.Position = NoPosition, flags: Universe.FlagSet = NoFlags): Universe.TypeSymbol

    See also

      InternalApi.newTypeSymbol

34.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
35.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
36.  val symbol: T
37.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
38.  def toString(): String
    Definition Classes
      AnyRef → Any
39.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
40.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
41.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException]) @native()

### Deprecated Value Members

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

### Inherited by implicit conversion StringFormat fromSymbolDecoratorApi[T] to StringFormat[SymbolDecoratorApi[T]]

### Inherited by implicit conversion Ensuring fromSymbolDecoratorApi[T] to Ensuring[SymbolDecoratorApi[T]]

### Inherited by implicit conversion ArrowAssoc fromSymbolDecoratorApi[T] to ArrowAssoc[SymbolDecoratorApi[T]]

### Ungrouped