scala.reflect.api.Internals

# FreeTypeSymbol

#### abstract type FreeTypeSymbol >: Null <: Universe.FreeTypeSymbolApi with Universe.TypeSymbol

The type of free types introduced by reification.

Linear Supertypes
Universe.<refinement>, Universe.<refinement>, Universe.FreeTypeSymbolApi, Universe.TypeSymbolApi, Universe.SymbolApi, AnyRef, Any
Ordering

1. Grouped
2. Alphabetic
3. By inheritance

Inherited

1. FreeTypeSymbol
2. <refinement>
3. <refinement>
4. FreeTypeSymbolApi
5. TypeSymbolApi
6. SymbolApi
7. AnyRef
8. Any

1. Hide All
2. Show all

Learn more about member selection
Visibility

1. Public
2. All

### Type Members

1. #### final type NameType = Universe.TypeName

   Type symbols have their names of type `TypeName`.

   Type symbols have their names of type `TypeName`.

   Definition Classes
     TypeSymbolApi → SymbolApi

### Abstract Value Members

1. #### abstract def alternatives: List[Universe.Symbol]

   The overloaded alternatives of this symbol

   The overloaded alternatives of this symbol

   Definition Classes
     SymbolApi

2. #### abstract def annotations: List[Universe.Annotation]

   A list of annotations attached to this Symbol.

   A list of annotations attached to this Symbol.

   Definition Classes
     SymbolApi

3. #### abstract def companion: Universe.Symbol

   For a class: its companion object if exists.

   For a class: its companion object if exists. For a module or a module class: companion class of the module if exists. For a package or a package class: NoSymbol. For all others: NoSymbol.

   Definition Classes
     SymbolApi

4. #### abstract def filter(cond: (Universe.Symbol) ⇒ Boolean): Universe.Symbol

   Filters the underlying alternatives (or a single-element list composed of the symbol itself if the symbol is not overloaded).

   Filters the underlying alternatives (or a single-element list composed of the symbol itself if the symbol is not overloaded). Returns an overloaded symbol is there are multiple matches. Returns a NoSymbol if there are no matches.

   Definition Classes
     SymbolApi

5. #### abstract def fullName: String

   The encoded full path name of this symbol, where outer names and inner names are separated by periods.

   The encoded full path name of this symbol, where outer names and inner names are separated by periods.

   Definition Classes
     SymbolApi

6. #### abstract def info: Universe.Type

   The type signature of this symbol.

   The type signature of this symbol.

   This method always returns signatures in the most generic way possible, even if the underlying symbol is obtained from an instantiation of a generic type. For example, signature of the method `def map[B](f: (A) ⇒ B): List[B]`, which refers to the type parameter `A` of the declaring class `List[A]`, will always feature `A`, regardless of whether `map` is loaded from the `List[_]` or from `List[Int]`. To get a signature with type parameters appropriately instantiated, one should use `infoIn`.

   Definition Classes
     SymbolApi

7. #### abstract def infoIn(site: Universe.Type): Universe.Type

   The type signature of this symbol seen as a member of given type `site`.

   The type signature of this symbol seen as a member of given type `site`.

   Definition Classes
     SymbolApi

8. #### abstract def isAbstract: Boolean

   Is this symbol abstract (i.

   Is this symbol abstract (i.e. an abstract class, an abstract method, value or type member)?

   Definition Classes
     SymbolApi

9. #### abstract def isAbstractOverride: Boolean

   Is this symbol labelled as "abstract override"?

   Is this symbol labelled as "abstract override"?

   Definition Classes
     SymbolApi

10. #### abstract def isAliasType: Boolean

    Does this symbol represent the definition of a type alias?

    Does this symbol represent the definition of a type alias?

    Definition Classes
      TypeSymbolApi

11. #### abstract def isConstructor: Boolean

    Does this method represent a constructor?

    Does this method represent a constructor?

    If `owner` is a class, then this is a vanilla JVM constructor. If `owner` is a trait, then this is a mixin constructor.

    Definition Classes
      SymbolApi

12. #### abstract def isContravariant: Boolean

    Is the type parameter represented by this symbol contravariant?

    Is the type parameter represented by this symbol contravariant?

    Definition Classes
      TypeSymbolApi

13. #### abstract def isCovariant: Boolean

    Is the type parameter represented by this symbol contravariant?

    Is the type parameter represented by this symbol contravariant?

    Definition Classes
      TypeSymbolApi

14. #### abstract def isExistential: Boolean

    Does this symbol represent an existentially bound type?

    Does this symbol represent an existentially bound type?

    Definition Classes
      TypeSymbolApi

15. #### abstract def isFinal: Boolean

    Is this symbol final?

    Is this symbol final?

    Definition Classes
      SymbolApi

16. #### abstract def isImplementationArtifact: Boolean

    Does this symbol represent an implementation artifact that isn't meant for public use? Examples of such artifacts are erasure bridges and outer fields.

    Does this symbol represent an implementation artifact that isn't meant for public use? Examples of such artifacts are erasure bridges and outer fields.

    Definition Classes
      SymbolApi

17. #### abstract def isImplicit: Boolean

    Does this symbol represent an implicit value, definition, class or parameter?

    Does this symbol represent an implicit value, definition, class or parameter?

    Definition Classes
      SymbolApi

18. #### abstract def isJava: Boolean

    Is this symbol defined by Java?

    Is this symbol defined by Java?

    Definition Classes
      SymbolApi

19. #### abstract def isMacro: Boolean

    Is this symbol a macro?

    Is this symbol a macro?

    Definition Classes
      SymbolApi

20. #### abstract def isPackage: Boolean

    Does this symbol represent the definition of a package? Known issues: https://issues.scala-lang.org/browse/SI-6732.

    Does this symbol represent the definition of a package? Known issues: https://issues.scala-lang.org/browse/SI-6732.

    Definition Classes
      SymbolApi

21. #### abstract def isPackageClass: Boolean

    Does this symbol represent a package class? If yes, `isClass` is also guaranteed to be true.

    Does this symbol represent a package class? If yes, `isClass` is also guaranteed to be true.

    Definition Classes
      SymbolApi

22. #### abstract def isParameter: Boolean

    Is this symbol a parameter (either a method parameter or a type parameter)?

    Is this symbol a parameter (either a method parameter or a type parameter)?

    Definition Classes
      SymbolApi

23. #### abstract def isPrivate: Boolean

    Does this symbol represent a private declaration or definition? If yes, `privateWithin` might tell more about this symbol's visibility scope.

    Does this symbol represent a private declaration or definition? If yes, `privateWithin` might tell more about this symbol's visibility scope.

    Definition Classes
      SymbolApi

24. #### abstract def isPrivateThis: Boolean

    Does this symbol represent a declaration or definition written in a source file as `private[this]` or generated in tree/symbol form with the combination of flags LOCAL and PRIVATE? If yes, `isPrivate` is guaranteed to be true,

    Does this symbol represent a declaration or definition written in a source file as `private[this]` or generated in tree/symbol form with the combination of flags LOCAL and PRIVATE? If yes, `isPrivate` is guaranteed to be true,

    Definition Classes
      SymbolApi

25. #### abstract def isProtected: Boolean

    Does this symbol represent a protected declaration or definition? If yes, `privateWithin` might tell more about this symbol's visibility scope.

    Does this symbol represent a protected declaration or definition? If yes, `privateWithin` might tell more about this symbol's visibility scope.

    Definition Classes
      SymbolApi

26. #### abstract def isProtectedThis: Boolean

    Does this symbol represent a declaration or definition written in a source file as `protected[this]` or generated in tree/symbol form with the combination of flags LOCAL and PROTECTED? If yes, `isProtected` is guaranteed to be true,

    Does this symbol represent a declaration or definition written in a source file as `protected[this]` or generated in tree/symbol form with the combination of flags LOCAL and PROTECTED? If yes, `isProtected` is guaranteed to be true,

    Definition Classes
      SymbolApi

27. #### abstract def isPublic: Boolean

    Does this symbol represent a public declaration or definition?

    Does this symbol represent a public declaration or definition?

    Definition Classes
      SymbolApi

28. #### abstract def isSpecialized: Boolean

    Is this symbol a specialized type parameter or a generated specialized member?

    Is this symbol a specialized type parameter or a generated specialized member?

    Definition Classes
      SymbolApi

29. #### abstract def isStatic: Boolean

    Is this symbol static (i.

    Is this symbol static (i.e. with no outer instance)? Q: When exactly is a sym marked as STATIC? A: If it's a member of a toplevel object, or of an object contained in a toplevel object, or any number of levels deep. http://groups.google.com/group/scala-internals/browse_thread/thread/d385bcd60b08faf6

    Definition Classes
      SymbolApi

30. #### abstract def isSynthetic: Boolean

    Does this symbol represent a synthetic (i.

    Does this symbol represent a synthetic (i.e. a compiler-generated) entity? Examples of synthetic entities are accessors for vals and vars or mixin constructors in trait implementation classes.

    Definition Classes
      SymbolApi

31. #### abstract def map(f: (Universe.Symbol) ⇒ Universe.Symbol): Universe.Symbol

    If this is a NoSymbol, returns NoSymbol, otherwise returns the result of applying `f` to this symbol.

    If this is a NoSymbol, returns NoSymbol, otherwise returns the result of applying `f` to this symbol.

    Definition Classes
      SymbolApi

32. #### abstract def name: Symbols.Symbol.NameType

    The name of the symbol as a member of the `Name` type.

    The name of the symbol as a member of the `Name` type.

    Definition Classes
      SymbolApi

33. #### abstract def orElse(alt: ⇒ Universe.Symbol): Universe.Symbol

    Provides an alternate if symbol is a NoSymbol.

    Provides an alternate if symbol is a NoSymbol.

    Definition Classes
      SymbolApi

34. #### abstract def origin: String

    The place where this symbol has been spawned

    The place where this symbol has been spawned

    Definition Classes
      FreeTypeSymbolApi

35. #### abstract def overrides: List[Universe.Symbol]

    Returns all symbols overriden by this symbol.

    Returns all symbols overriden by this symbol.

    Definition Classes
      SymbolApi

36. #### abstract def owner: Universe.Symbol

    The owner of this symbol.

    The owner of this symbol. This is the symbol that directly contains the current symbol's definition. The `NoSymbol` symbol does not have an owner, and calling this method on one causes an internal error. The owner of the Scala root class scala.reflect.api.Mirror.RootClass and the Scala root object scala.reflect.api.Mirror.RootPackage is `NoSymbol`. Every other symbol has a chain of owners that ends in scala.reflect.api.Mirror.RootClass.

    Definition Classes
      SymbolApi

37. #### abstract def pos: Universe.Position

    Position of the tree.

    Position of the tree.

    Definition Classes
      SymbolApi

38. #### abstract def privateWithin: Universe.Symbol

    Set when symbol has a modifier of the form private[X] or protected[X], NoSymbol otherwise.

    Set when symbol has a modifier of the form private[X] or protected[X], NoSymbol otherwise.

    Access level encoding: there are three scala flags (PRIVATE, PROTECTED, and LOCAL) which combine with value privateWithin (the "foo" in private[foo]) to define from where an entity can be accessed. The meanings are as follows:

    PRIVATE access restricted to class only. PROTECTED access restricted to class and subclasses only. LOCAL can only be set in conjunction with PRIVATE or PROTECTED. Further restricts access to the same object instance.

    In addition, privateWithin can be used to set a visibility barrier. When set, everything contained in the named enclosing package or class has access. It is incompatible with PRIVATE or LOCAL, but is additive with PROTECTED (i.e. if either the flags or privateWithin allow access, then it is allowed.)

    The java access levels translate as follows:

    java private: isPrivate && (privateWithin == NoSymbol) java package: !isPrivate && !isProtected && (privateWithin == enclosingPackage) java protected: isProtected && (privateWithin == enclosingPackage) java public: !isPrivate && !isProtected && (privateWithin == NoSymbol)

    Definition Classes
      SymbolApi

39. #### abstract def suchThat(cond: (Universe.Symbol) ⇒ Boolean): Universe.Symbol

    Does the same as `filter`, but crashes if there are multiple matches.

    Does the same as `filter`, but crashes if there are multiple matches.

    Definition Classes
      SymbolApi

40. #### abstract def toType: Universe.Type

    A type reference that refers to this type symbol Note if symbol is a member of a class, one almost always is interested in `asTypeIn` with a site type instead.

    A type reference that refers to this type symbol Note if symbol is a member of a class, one almost always is interested in `asTypeIn` with a site type instead.

    Example: Given a class declaration `class C[T] { ... }` , that generates a symbol `C`. Then `C.toType` is the type `C[T]`.

    By contrast, `C.info` would be a type signature of form `PolyType(ClassInfoType(...))` that describes type parameters, value parameters, parent types, and members of `C`.

    Definition Classes
      TypeSymbolApi

41. #### abstract def toTypeConstructor: Universe.Type

    The type constructor corresponding to this type symbol.

    The type constructor corresponding to this type symbol. This is different from `toType` in that type parameters are part of results of `toType`, but not of `toTypeConstructor`.

    Example: Given a class declaration `class C[T] { ... }` , that generates a symbol `C`. Then `C.toType` is the type `C[T]`, but `C.toTypeConstructor` is `C`.

    Definition Classes
      TypeSymbolApi

42. #### abstract def toTypeIn(site: Universe.Type): Universe.Type

    A type reference that refers to this type symbol seen as a member of given type `site`.

    A type reference that refers to this type symbol seen as a member of given type `site`.

    Definition Classes
      TypeSymbolApi

43. #### abstract def typeParams: List[Universe.Symbol]

    For a polymorphic type, its type parameters, the empty list for all other types

    For a polymorphic type, its type parameters, the empty list for all other types

    Definition Classes
      TypeSymbolApi

44. #### abstract def typeSignature: Universe.Type

    Definition Classes
      SymbolApi
    See also

      info

45. #### abstract def typeSignatureIn(site: Universe.Type): Universe.Type

    Definition Classes
      SymbolApi
    See also

      infoIn

46. #### abstract def allOverriddenSymbols: List[Universe.Symbol]

    Definition Classes
      SymbolApi
    Annotations
      @deprecated
    Deprecated

      (Since version 2.11.0) Use `overrides` instead

    See also

      overrides

47. #### abstract def associatedFile: AbstractFile

    Source file if this symbol is created during this compilation run, or a class file if this symbol is loaded from a *.

    Source file if this symbol is created during this compilation run, or a class file if this symbol is loaded from a *.class or *.jar.

    The return type is `scala.reflect.io.AbstractFile`, which belongs to an experimental part of Scala reflection. It should not be used unless you know what you are doing. In subsequent releases, this API will be refined and exposed as a part of scala.reflect.api.

    Definition Classes
      SymbolApi
    Annotations
      @deprecated
    Deprecated

      (Since version 2.11.0) Use `pos.source.file` instead

48. #### abstract def companionSymbol: Universe.Symbol

    For a class: the module or case class factory with the same name in the same package.

    For a class: the module or case class factory with the same name in the same package. For a module: the class with the same name in the same package. For all others: NoSymbol

    This API may return unexpected results for module classes, packages and package classes. Use `companion` instead in order to get predictable results.

    Definition Classes
      SymbolApi
    Annotations
      @deprecated
    Deprecated

      (Since version 2.11.0) Use `companion` instead, but beware of possible changes in behavior

49. #### abstract def isAbstractType: Boolean

    Does this symbol represent the definition of an abstract type?

    Does this symbol represent the definition of an abstract type?

    Definition Classes
      TypeSymbolApi
    Annotations
      @deprecated
    Deprecated

      (Since version 2.11.0) Use isAbstract instead

### Concrete Value Members

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

   Definition Classes
     AnyRef → Any

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

   Definition Classes
     AnyRef → Any

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

   Definition Classes
     AnyRef → Any

4. #### def asClass: Universe.ClassSymbol

   This symbol cast to a ClassSymbol representing a class or trait.

   This symbol cast to a ClassSymbol representing a class or trait.

   Definition Classes
     SymbolApi
   Exceptions thrown
     ScalaReflectionException

     if `isClass` is false.

5. #### final def asInstanceOf[T0]: T0

   Definition Classes
     Any

6. #### def asMethod: Universe.MethodSymbol

   This symbol cast to a MethodSymbol.

   This symbol cast to a MethodSymbol.

   Definition Classes
     SymbolApi
   Exceptions thrown
     ScalaReflectionException

     if `isMethod` is false.

7. #### def asModule: Universe.ModuleSymbol

   This symbol cast to a ModuleSymbol defined by an object definition.

   This symbol cast to a ModuleSymbol defined by an object definition.

   Definition Classes
     SymbolApi
   Exceptions thrown
     ScalaReflectionException

     if `isModule` is false.

8. #### def asTerm: Universe.TermSymbol

   This symbol cast to a TermSymbol.

   This symbol cast to a TermSymbol.

   Definition Classes
     SymbolApi
   Exceptions thrown
     ScalaReflectionException

     if `isTerm` is false.

9. #### final def asType: Universe.TypeSymbol

   This symbol cast to a TypeSymbol.

   This symbol cast to a TypeSymbol.

   Definition Classes
     TypeSymbolApi → SymbolApi
   Exceptions thrown
     ScalaReflectionException

     if `isType` is false.

10. #### def clone(): AnyRef

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

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

    Definition Classes
      AnyRef

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

    Definition Classes
      AnyRef → Any

13. #### def finalize(): Unit

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

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

    Definition Classes
      AnyRef → Any

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

    Definition Classes
      AnyRef → Any

16. #### def isClass: Boolean

    Does this symbol represent the definition of a class or trait? If yes, `isType` is also guaranteed to be true.

    Does this symbol represent the definition of a class or trait? If yes, `isType` is also guaranteed to be true.

    Definition Classes
      SymbolApi

17. #### final def isInstanceOf[T0]: Boolean

    Definition Classes
      Any

18. #### def isMethod: Boolean

    Does this symbol represent the definition of a method? If yes, `isTerm` is also guaranteed to be true.

    Does this symbol represent the definition of a method? If yes, `isTerm` is also guaranteed to be true.

    Definition Classes
      SymbolApi

19. #### def isModule: Boolean

    Does this symbol represent the definition of a module (i.

    Does this symbol represent the definition of a module (i.e. it results from an object definition?). If yes, `isTerm` is also guaranteed to be true.

    Definition Classes
      SymbolApi

20. #### def isModuleClass: Boolean

    Does this symbol represent the definition of a class implicitly associated with an object definition (module class in scala compiler parlance).

    Does this symbol represent the definition of a class implicitly associated with an object definition (module class in scala compiler parlance). If yes, `isType` is also guaranteed to be true.

    Definition Classes
      SymbolApi

21. #### def isOverloadedMethod: Boolean

    Used to provide a better error message for `asMethod`

    Used to provide a better error message for `asMethod`

    Attributes
      protected
    Definition Classes
      SymbolApi

22. #### def isTerm: Boolean

    Does this symbol represent the definition of a term? Note that every symbol is either a term or a type.

    Does this symbol represent the definition of a term? Note that every symbol is either a term or a type. So for every symbol `sym` (except for `NoSymbol`), either `sym.isTerm` is true or `sym.isType` is true.

    Definition Classes
      SymbolApi

23. #### final def isType: Boolean

    Does this symbol represent the definition of a type? Note that every symbol is either a term or a type.

    Does this symbol represent the definition of a type? Note that every symbol is either a term or a type. So for every symbol `sym` (except for `NoSymbol`), either `sym.isTerm` is true or `sym.isType` is true.

    Definition Classes
      TypeSymbolApi → SymbolApi

24. #### final def ne(arg0: AnyRef): Boolean

    Definition Classes
      AnyRef

25. #### final def notify(): Unit

    Definition Classes
      AnyRef

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

    Definition Classes
      AnyRef

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

    Definition Classes
      AnyRef

28. #### def toString(): String

    Definition Classes
      AnyRef → Any

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

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

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

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

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

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

### Inherited from Universe.<refinement>

### Inherited from Universe.FreeTypeSymbolApi

### Inherited from Universe.TypeSymbolApi

### Inherited from Universe.SymbolApi

### Inherited from AnyRef

### Inherited from Any

### Method Symbol Members

### TypeSymbol Members

### Symbol Basic Information

### FreeType

### Symbol Type Tests

### Symbol Conversions

### Iteration Helpers

These methods enable collections-like operations on symbols.

### Ungrouped