W3cubDocs

/Scala 2.13 Reflection

Annotation scala.reflect.api.Symbols.ClassSymbol

abstract type ClassSymbol >: Null <: Universe.ClassSymbolApi with Universe.TypeSymbol

The type of class symbols representing class and trait definitions.

Source
Symbols.scala
Linear Supertypes
Universe.<refinement>, Universe.<refinement>, Universe.ClassSymbolApi, Universe.TypeSymbolApi, Universe.SymbolApi, AnyRef, Any

Type Members

final type NameType = Universe.TypeName

Type symbols have their names of type TypeName.

Definition Classes
TypeSymbolApiSymbolApi

Abstract Value Members

abstract def alternatives: List[Universe.Symbol]

The overloaded alternatives of this symbol.

Definition Classes
SymbolApi

abstract def annotations: List[Universe.Annotation]

A list of annotations attached to this Symbol.

Definition Classes
SymbolApi

abstract def baseClasses: List[Universe.Symbol]

The list of all base classes of this type (including its own typeSymbol) in linearization order, starting with the class itself and ending in class Any.

Definition Classes
ClassSymbolApi

abstract def companion: Universe.Symbol

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

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). Returns an overloaded symbol is there are multiple matches. Returns a NoSymbol if there are no matches.

Definition Classes
SymbolApi

abstract def fullName: String

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

Definition Classes
SymbolApi

abstract def info: Universe.Type

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

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

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

Definition Classes
SymbolApi

abstract def isAbstract: Boolean

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

Definition Classes
SymbolApi

abstract def isAbstractOverride: Boolean

Is this symbol labelled as "abstract override"?

Definition Classes
SymbolApi

abstract def isAliasType: Boolean

Does this symbol represent the definition of a type alias?

Definition Classes
TypeSymbolApi

abstract def isCaseClass: Boolean

Does this symbol represent a case class?

Definition Classes
ClassSymbolApi

abstract def isConstructor: Boolean

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

abstract def isContravariant: Boolean

Is the type parameter represented by this symbol contravariant?

Definition Classes
TypeSymbolApi

abstract def isCovariant: Boolean

Is the type parameter represented by this symbol contravariant?

Definition Classes
TypeSymbolApi

abstract def isDerivedValueClass: Boolean

Does this symbol represent the definition of a custom value class? Namely, is AnyVal among its parent classes?

Definition Classes
ClassSymbolApi

abstract def isExistential: Boolean

Does this symbol represent an existentially bound type?

Definition Classes
TypeSymbolApi

abstract def isFinal: Boolean

Is this symbol final?

Definition Classes
SymbolApi

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.

Definition Classes
SymbolApi

abstract def isImplicit: Boolean

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

Definition Classes
SymbolApi

abstract def isJava: Boolean

Is this symbol defined by Java?

Definition Classes
SymbolApi

abstract def isJavaAnnotation: Boolean

Does this symbol represent a java annotation interface?

Definition Classes
SymbolApi

abstract def isJavaEnum: Boolean

Does this symbol represent a java enum class or a java enum value?

Definition Classes
SymbolApi

abstract def isMacro: Boolean

Is this symbol a macro?

Definition Classes
SymbolApi

abstract def isNumeric: Boolean

Does this symbol represent the definition of a numeric value class? Namely, is it one of scala.Double, scala.Float, scala.Long, scala.Int, scala.Char, scala.Short, scala.Byte, scala.Unit or scala.Boolean?

Definition Classes
ClassSymbolApi

abstract def isPackage: Boolean

Does this symbol represent the definition of a package? Known issues: https://github.com/scala/bug/issues/6732.

Definition Classes
SymbolApi

abstract def isPackageClass: Boolean

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

Definition Classes
SymbolApi

abstract def isParameter: Boolean

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

Definition Classes
SymbolApi

abstract def isPrimitive: Boolean

Does this symbol represent the definition of a primitive class? Namely, is it one of scala.Double, scala.Float, scala.Long, scala.Int, scala.Char, scala.Short, scala.Byte, scala.Unit or scala.Boolean?

Definition Classes
ClassSymbolApi

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.

Definition Classes
SymbolApi

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.

Definition Classes
SymbolApi

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.

Definition Classes
SymbolApi

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,

Definition Classes
SymbolApi

abstract def isPublic: Boolean

Does this symbol represent a public declaration or definition?

Definition Classes
SymbolApi

abstract def isSealed: Boolean

Does this symbol represent a sealed class?

Definition Classes
ClassSymbolApi

abstract def isSpecialized: Boolean

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

Definition Classes
SymbolApi

abstract def isStatic: Boolean

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

abstract def isSynthetic: Boolean

Does this symbol represent a synthetic (i.e. a compiler-generated) entity? Examples of synthetic entities are accessors for vals and vars.

Definition Classes
SymbolApi

abstract def isTrait: Boolean

Does this symbol represent a trait?

Definition Classes
ClassSymbolApi

abstract def knownDirectSubclasses: Set[Universe.Symbol]

If this is a sealed class, its known direct subclasses. Otherwise, the empty set.

Definition Classes
ClassSymbolApi

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.

Definition Classes
SymbolApi

abstract def module: Universe.Symbol

The module corresponding to this module class, or NoSymbol if this symbol is not a module class.

Definition Classes
ClassSymbolApi

abstract def name: Symbol.NameType

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

Definition Classes
SymbolApi

abstract def orElse(alt: => Universe.Symbol): Universe.Symbol

Provides an alternate if symbol is a NoSymbol.

Definition Classes
SymbolApi

abstract def overrides: List[Universe.Symbol]

Returns all symbols overridden by this symbol.

Definition Classes
SymbolApi

abstract def owner: Universe.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

abstract def pos: Universe.Position

Position of the tree.

Definition Classes
SymbolApi

abstract def primaryConstructor: Universe.Symbol

For a Scala class or module class, the primary constructor of the class. For a Scala trait, its mixin constructor. For a Scala package class, NoSymbol. For a Java class, NoSymbol.

Known issues: Due to scala/bug#8367, primaryConstructor may return unexpected results when called for Java classes (for some vague definition of a "Java class", which apparently not only includes javac-produced classfiles, but also consists of classes defined in Scala programs under the java.lang package). What's even worse, for some Java classes we can't even guarantee stability of the return value - depending on your classloader configuration and/or JDK version you might get different primaryConstructor for the same ClassSymbol. We have logged these issues at scala/bug#8193.

Definition Classes
ClassSymbolApi

abstract def privateWithin: Universe.Symbol

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

abstract def selfType: Universe.Type

If this symbol is a class or trait, its self type, otherwise the type of the symbol itself.

Definition Classes
ClassSymbolApi

abstract def suchThat(cond: (Universe.Symbol) => Boolean): Universe.Symbol

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

Definition Classes
SymbolApi

abstract def superPrefix(supertpe: Universe.Type): Universe.Type

The type C.super[M], where C is the current class and M is supertpe.

Definition Classes
ClassSymbolApi

abstract def thisPrefix: Universe.Type

The type C.this, where C is the current class

Definition Classes
ClassSymbolApi

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.

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

abstract def toTypeConstructor: Universe.Type

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

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.

Definition Classes
TypeSymbolApi

abstract def typeParams: List[Universe.Symbol]

For a polymorphic class/trait, its type parameters, the empty list for all other classes/trait.

Definition Classes
ClassSymbolApiTypeSymbolApi

abstract def typeSignature: Universe.Type

Definition Classes
SymbolApi
See also

info

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

Definition Classes
SymbolApi
See also

infoIn

abstract def allOverriddenSymbols: List[Universe.Symbol]

Definition Classes
SymbolApi
Annotations
@deprecated
Deprecated

(Since version 2.11.0) use overrides instead

See also

overrides

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

abstract def companionSymbol: Universe.Symbol

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

abstract def isAbstractClass: Boolean

Does this symbol represent an abstract class?

Definition Classes
ClassSymbolApi
Annotations
@deprecated
Deprecated

(Since version 2.11.0) use isAbstract instead

abstract def isAbstractType: Boolean

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

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any

final def ##(): Int

Definition Classes
AnyRef → Any

final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any

final def asClass: Universe.ClassSymbol

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

Definition Classes
ClassSymbolApiSymbolApi
Exceptions thrown

ScalaReflectionException if isClass is false.

final def asInstanceOf[T0]: T0

Definition Classes
Any

def asMethod: Universe.MethodSymbol

This symbol cast to a MethodSymbol.

Definition Classes
SymbolApi
Exceptions thrown

ScalaReflectionException if isMethod is false.

def asModule: Universe.ModuleSymbol

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

Definition Classes
SymbolApi
Exceptions thrown

ScalaReflectionException if isModule is false.

def asTerm: Universe.TermSymbol

This symbol cast to a TermSymbol.

Definition Classes
SymbolApi
Exceptions thrown

ScalaReflectionException if isTerm is false.

final def asType: Universe.TypeSymbol

This symbol cast to a TypeSymbol.

Definition Classes
TypeSymbolApiSymbolApi
Exceptions thrown

ScalaReflectionException if isType is false.

def clone(): AnyRef

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

final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef

def equals(arg0: AnyRef): Boolean

Definition Classes
AnyRef → Any

def finalize(): Unit

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

final def getClass(): Class[_ <: AnyRef]

Definition Classes
AnyRef → Any
Annotations
@native()

def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@native()

final def isClass: Boolean

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

Definition Classes
ClassSymbolApiSymbolApi

final def isInstanceOf[T0]: Boolean

Definition Classes
Any

def isMethod: Boolean

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

Definition Classes
SymbolApi

def isModule: Boolean

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

def isModuleClass: Boolean

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

def isOverloadedMethod: Boolean

Used to provide a better error message for asMethod.

Attributes
protected
Definition Classes
SymbolApi

def isTerm: Boolean

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

final def isType: Boolean

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
TypeSymbolApiSymbolApi

final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef

final def notify(): Unit

Definition Classes
AnyRef
Annotations
@native()

final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@native()

final def synchronized[T0](arg0: => T0): T0

Definition Classes
AnyRef

def toString(): String

Definition Classes
AnyRef → Any

final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

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

Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()

© 2002-2019 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://www.scala-lang.org/api/2.13.0/scala-reflect/scala/reflect/api/Symbols$ClassSymbol.html