tasty-query/tastyquery/Symbols/ClassSymbol

ClassSymbol

final
class ClassSymbol extends TypeSymbol with DeclaringSymbol
Companion
object
class Symbol
class Object
trait Matchable
class Any

Type members

Types

Inherited types

type ThisNameType = TypeName
Inherited from
TypeSymbol

Value members

Concrete methods

final
def companionClass(using Context): Option[ClassSymbol]

Get the companion class of this class, if it exists:

Get the companion class of this class, if it exists:

  • for class C => object class C[$]
  • for object class C[$] => class C
final
def declarations(using Context): List[TermOrTypeSymbol]
final
def findAllOverloadedDecls(name: TermName)(using Context): List[TermSymbol]

Returns a list of all the overloaded declarations with the given unsigned name.

Returns a list of all the overloaded declarations with the given unsigned name.

Throws
java.lang.IllegalArgumentException

if the provided name is a SignedName

tastyquery.Exceptions.MemberNotFoundException

if there is no declaration with the given unsigned name

final
def findDecl(name: Name)(using Context): TermOrTypeSymbol
final
def findDecl(name: TypeName)(using Context): TypeSymbol
final
def findDecl(name: TermName)(using Context): TermSymbol
final
def findNonOverloadedDecl(name: TermName)(using Context): TermSymbol

Convenience method to find a non-overloaded decl from its unsigned name.

Convenience method to find a non-overloaded decl from its unsigned name.

Throws
java.lang.IllegalArgumentException

if the provided name is a SignedName

tastyquery.Exceptions.MemberNotFoundException

if there are multiple or no overload with the given unsigned name

final
def getAllOverloadedDecls(name: TermName)(using Context): List[TermSymbol]

Returns a list of all the overloaded declarations with the given unsigned name.

Returns a list of all the overloaded declarations with the given unsigned name.

If there is no declaration with the given unsigned name, this method returns Nil.

Throws
java.lang.IllegalArgumentException

if the provided name is a SignedName

final
def getDecl(name: Name)(using Context): Option[TermOrTypeSymbol]
final
def getDecl(name: TypeName)(using Context): Option[TypeSymbol]
final
def getDecl(name: TermName)(using Context): Option[TermSymbol]
final
def getNonOverloadedDecl(name: TermName)(using Context): Option[TermSymbol]

Convenience method to get a non-overloaded decl from its unsigned name.

Convenience method to get a non-overloaded decl from its unsigned name.

If there are multiple or no overload with the given unsigned name, this method returns None.

Throws
java.lang.IllegalArgumentException

if the provided name is a SignedName

final
def isSubclass(that: ClassSymbol)(using Context): Boolean
final
def linearization(using Context): List[ClassSymbol]
final
def moduleValue(using Context): Option[TermSymbol]

Get the module value of this module class definition, if it exists:

Get the module value of this module class definition, if it exists:

  • for object class C[$] => object val C
def parentClasses(using Context): List[ClassSymbol]
final
def parents(using Context): List[Type]
final
def typeParams(using Context): List[ClassTypeParamSymbol]

Deprecated methods

@deprecated("use getAllOverloadedDecls", "0.4.0")
final
def getDecls(name: Name)(using Context): List[TermOrTypeSymbol]
Deprecated

Inherited methods

final
def allOverriddenSymbols(using Context): Iterator[Symbol]

All symbols overridden by this symbol.

All symbols overridden by this symbol.

Inherited from
TermOrTypeSymbol
final
def annotations: List[Annotation]
Inherited from
Symbol
final
def asClass: ClassSymbol
Inherited from
Symbol
final
def asDeclaringSymbol: DeclaringSymbol
Inherited from
Symbol
final
def asPackage: PackageSymbol
Inherited from
Symbol
final
def asTerm: TermSymbol
Inherited from
Symbol
final
def asType: TypeSymbol
Inherited from
Symbol
final
def enclosingDecl: DeclaringSymbol
Inherited from
Symbol
final protected
def failNotCompleted(details: String): Nothing
Inherited from
Symbol
final
def flags: FlagSet
Inherited from
Symbol
final
def fullName: FullyQualifiedName
Inherited from
Symbol
final
def getAnnotation(annotClass: ClassSymbol)(using Context): Option[Annotation]
Inherited from
Symbol
final
def getAnnotations(annotClass: ClassSymbol)(using Context): List[Annotation]
Inherited from
Symbol
final
def hasAnnotation(annotClass: ClassSymbol)(using Context): Boolean
Inherited from
Symbol
final
def is(flag: Flag): Boolean
Inherited from
Symbol
final
def isAllOf(testFlags: FlagSet, butNotAnyOf: FlagSet): Boolean
Inherited from
Symbol
final
def isAllOf(testFlags: FlagSet): Boolean
Inherited from
Symbol
final
def isAnyOf(testFlags: FlagSet): Boolean
Inherited from
Symbol
final
def isClass: Boolean
Inherited from
Symbol
final
def isDeclaringSymbol: Boolean
Inherited from
Symbol
final
def isOpaqueTypeAlias(using Context): Boolean
Inherited from
TypeSymbol
final
def isPackage: Boolean
Inherited from
Symbol
final
def isRoot: Boolean
Inherited from
Symbol
final
def isTerm: Boolean
Inherited from
Symbol
final
def isType: Boolean
Inherited from
Symbol
final
def isTypeAlias(using Context): Boolean
Inherited from
TypeSymbol
final
def nextOverriddenSymbol(using Context): Option[Symbol]

The first symbol overridden by this symbol, if any.

The first symbol overridden by this symbol, if any.

Inherited from
TermOrTypeSymbol
final
def overriddenSymbol(inClass: ClassSymbol)(using Context): Option[Symbol]

The symbol, in class inClass, that is overridden by this symbol, if any.

The symbol, in class inClass, that is overridden by this symbol, if any.

Inherited from
TermOrTypeSymbol
final
def overrides(that: TermOrTypeSymbol)(using Context): Boolean

Returns true iff this symbol override that symbol.

Returns true iff this symbol override that symbol.

Inherited from
TermOrTypeSymbol
final
def overridingSymbol(inClass: ClassSymbol)(using Context): Option[Symbol]

The symbol overriding this symbol in given subclass inClass, if any.

The symbol overriding this symbol in given subclass inClass, if any.

Inherited from
TermOrTypeSymbol
final
def privateWithin: Option[Symbol]
Inherited from
Symbol
def toDebugString: String
Inherited from
Symbol
override
def toString: String
Definition Classes
Symbol -> Any
Inherited from
Symbol
final
def tree(using Context): Option[DefiningTreeType]
Inherited from
Symbol