MethodSymbolApi
Related Doc:
package Symbols
Exceptions that this method is known to throw.
Exceptions that this method is known to throw.
For Scala methods, the list is calculated from throws annotations present on a method.
For Java methods, the list is calculated from throws clauses attached to the method and stored in bytecode.
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.
Does this symbol denote the primary constructor of its enclosing class?
Does this method support variable length argument lists?
All parameter lists of the method.
All parameter lists of the method. The name ending with "ss" indicates that the result type is a list of lists.
Can be used to distinguish nullary methods and methods with empty parameter lists.
For a nullary method, returns the empty list (i.e. List()).
For a method with an empty parameter list, returns a list that contains the empty list (i.e. List(List())).
The return type of the method
For a polymorphic method, its type parameters, the empty list for all other methods
Backing field for an accessor method, NoSymbol for all other term symbols.
Backing field for an accessor method, NoSymbol for all other term symbols.
Getter method for a backing field of a val or a val, NoSymbol for all other term symbols.
Getter method for a backing field of a val or a val, NoSymbol for all other term symbols.
Does this symbol represent a getter or a setter?
Does this symbol represent a getter or a setter?
Does this symbol represent a by-name parameter?
Does this symbol represent a by-name parameter?
Does this symbol represent a field of a case class that corresponds to a parameter in the first parameter list of the primary constructor of that class?
Does this symbol represent a field of a case class that corresponds to a parameter in the first parameter list of the primary constructor of that class?
Does this symbol represent a getter of a field?
If yes, isMethod is also guaranteed to be true.
Does this symbol represent a getter of a field?
If yes, isMethod is also guaranteed to be true.
Does this symbol represent a lazy value?
Does this symbol represent a lazy value?
Does this symbol represent an overloaded method?
If yes, isMethod is false, and the list of the enclosed alternatives can be found out via alternatives.
Does this symbol represent an overloaded method?
If yes, isMethod is false, and the list of the enclosed alternatives can be found out via alternatives.
Does this symbol represent a field of a class that was generated from a parameter of that class?
Does this symbol represent a field of a class that was generated from a parameter of that class?
Does this symbol represent a parameter with a default value?
Does this symbol represent a parameter with a default value?
Does this symbol represent a setter of a field?
If yes, isMethod is also guaranteed to be true.
Does this symbol represent a setter of a field?
If yes, isMethod is also guaranteed to be true.
Does this symbol denote a stable value?
Does this symbol denote a stable value?
Is this symbol introduced as val?
Is this symbol introduced as val?
Is this symbol introduced as var?
Is this symbol introduced as var?
Setter method for a backing field of a val or a val, NoSymbol for all other term symbols.
Setter method for a backing field of a val or a val, NoSymbol for all other term symbols.
Term symbols have their names of type TermName.
Term symbols have their names of type TermName.
The overloaded alternatives of this symbol
The overloaded alternatives of this symbol
A list of annotations attached to this Symbol.
A list of annotations attached to this Symbol.
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.
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.
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.
The name of the symbol as a member of the Name type.
The name of the symbol as a member of the Name type.
Returns all symbols overridden by this symbol.
Returns all symbols overridden by this 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.
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.
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.
(Since version 2.11.0) Use pos.source.file instead
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.
(Since version 2.11.0) Use companion instead, but beware of possible changes in behavior
Is this symbol abstract (i.e.
Is this symbol abstract (i.e. an abstract class, an abstract method, value or type member)?
Is this symbol labelled as "abstract override"?
Is this symbol labelled as "abstract override"?
Is this symbol final?
Is this symbol final?
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.
Does this symbol represent an implicit value, definition, class or parameter?
Does this symbol represent an implicit value, definition, class or parameter?
Is this symbol defined by Java?
Is this symbol defined by Java?
Is this symbol a macro?
Is this symbol a macro?
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.
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.
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)?
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.
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,
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.
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,
Does this symbol represent a public declaration or definition?
Does this symbol represent a public declaration or definition?
Is this symbol a specialized type parameter or a generated specialized member?
Is this symbol a specialized type parameter or a generated specialized member?
Is this symbol static (i.e.
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
Does this symbol represent a synthetic (i.e.
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.
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)
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.
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.
Does this symbol represent the definition of a module (i.e.
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.
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.
Note to compiler developers: During the "mixin" phase, trait implementation class symbols
receive the lateMODULE flag, hence isImplClass && isModuleClass becomes true.
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.
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.
This symbol cast to a ClassSymbol representing a class or trait.
This symbol cast to a ClassSymbol representing a class or trait.
ScalaReflectionException if isClass is false.
This symbol cast to a MethodSymbol.
This symbol cast to a MethodSymbol.
ScalaReflectionException if isMethod is false.
This symbol cast to a ModuleSymbol defined by an object definition.
This symbol cast to a ModuleSymbol defined by an object definition.
ScalaReflectionException if isModule is false.
This symbol cast to a TermSymbol.
This symbol cast to a TermSymbol.
ScalaReflectionException if isTerm is false.
This symbol cast to a TypeSymbol.
This symbol cast to a TypeSymbol.
ScalaReflectionException if isType is false.
These methods enable collections-like operations on symbols.
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.
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.
Provides an alternate if symbol is a NoSymbol.
Provides an alternate if symbol is a NoSymbol.
Does the same as filter, but crashes if there are multiple matches.
Does the same as filter, but crashes if there are multiple matches.
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.
Position of the tree.
Position of the tree.
(Since version 2.11.0) Use paramLists instead
The API of method symbols. The main source of information about symbols is the Symbols page.
Class Symbol defines
isXXXtest methods such asisPublicorisFinal,paramsandreturnTypemethods for method symbols,baseClassesfor class symbols and so on. Some of these methods don't make sense for certain subclasses ofSymboland returnNoSymbol,Nilor other empty values.