abstract type MethodSymbol >: Null <: Universe.MethodSymbolApi with Universe.TermSymbol
- Grouped
- Alphabetic
- By Inheritance
- MethodSymbol
- <refinement>
- <refinement>
- MethodSymbolApi
- TermSymbolApi
- SymbolApi
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- final type NameType = Universe.TermName
Term symbols have their names of type
TermName
.Term symbols have their names of type
TermName
.- Definition Classes
- TermSymbolApi → SymbolApi
Abstract Value Members
- abstract def accessed: Universe.Symbol
Backing field for an accessor method, NoSymbol for all other term symbols.
Backing field for an accessor method, NoSymbol for all other term symbols.
- Definition Classes
- TermSymbolApi
- abstract def alternatives: List[Universe.Symbol]
The overloaded alternatives of this symbol.
The overloaded alternatives of this symbol.
- Definition Classes
- SymbolApi
- 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
- 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
- abstract def exceptions: List[Universe.Symbol]
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.- Definition Classes
- MethodSymbolApi
- 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
- 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
- abstract def getter: Universe.Symbol
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.
- Definition Classes
- TermSymbolApi
- 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 parameterA
of the declaring classList[A]
, will always featureA
, regardless of whethermap
is loaded from theList[_]
or fromList[Int]
. To get a signature with type parameters appropriately instantiated, one should useinfoIn
.- 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
.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.
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"?
Is this symbol labelled as "abstract override"?
- Definition Classes
- SymbolApi
- abstract def isAccessor: Boolean
Does this symbol represent a getter or a setter?
Does this symbol represent a getter or a setter?
- Definition Classes
- TermSymbolApi
- abstract def isByNameParam: Boolean
Does this symbol represent a by-name parameter?
Does this symbol represent a by-name parameter?
- Definition Classes
- TermSymbolApi
- abstract def isCaseAccessor: Boolean
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?
- Definition Classes
- TermSymbolApi
- 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. Ifowner
is a trait, then this is a mixin constructor.- Definition Classes
- SymbolApi
- abstract def isFinal: Boolean
Is this symbol final?
Is this symbol final?
- Definition Classes
- SymbolApi
- abstract def isGetter: Boolean
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.- Definition Classes
- TermSymbolApi
- 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
- 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
- abstract def isJava: Boolean
Is this symbol defined by Java?
Is this symbol defined by Java?
- Definition Classes
- SymbolApi
- abstract def isJavaAnnotation: Boolean
Does this symbol represent a java annotation interface?
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?
Does this symbol represent a java enum class or a java enum value?
- Definition Classes
- SymbolApi
- abstract def isLazy: Boolean
Does this symbol represent a lazy value?
Does this symbol represent a lazy value?
- Definition Classes
- TermSymbolApi
- abstract def isMacro: Boolean
Is this symbol a macro?
Is this symbol a macro?
- Definition Classes
- SymbolApi
- abstract def isOverloaded: Boolean
Does this symbol represent an overloaded method? If yes,
isMethod
is false, and the list of the enclosed alternatives can be found out viaalternatives
.Does this symbol represent an overloaded method? If yes,
isMethod
is false, and the list of the enclosed alternatives can be found out viaalternatives
.- Definition Classes
- TermSymbolApi
- abstract def isPackage: Boolean
Does this symbol represent the definition of a package? Known issues: https://github.com/scala/bug/issues/6732.
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.Does this symbol represent a package class? If yes,
isClass
is also guaranteed to be true.- Definition Classes
- SymbolApi
- abstract def isParamAccessor: Boolean
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?
- Definition Classes
- TermSymbolApi
- abstract def isParamWithDefault: Boolean
Does this symbol represent a parameter with a default value?
Does this symbol represent a parameter with a default value?
- Definition Classes
- TermSymbolApi
- 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
- abstract def isPrimaryConstructor: Boolean
Does this symbol denote the primary constructor of its enclosing class?
Does this symbol denote the primary constructor of its enclosing class?
- Definition Classes
- MethodSymbolApi
- 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
- 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
- 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
- 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
- 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
- abstract def isSetter: Boolean
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.- Definition Classes
- TermSymbolApi
- 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
- abstract def isStable: Boolean
Does this symbol denote a stable value?
Does this symbol denote a stable value?
- Definition Classes
- TermSymbolApi
- abstract def isStatic: Boolean
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. https://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.
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 isVal: Boolean
Is this symbol introduced as
val
?Is this symbol introduced as
val
?- Definition Classes
- TermSymbolApi
- abstract def isVar: Boolean
Is this symbol introduced as
var
?Is this symbol introduced as
var
?- Definition Classes
- TermSymbolApi
- abstract def isVarargs: Boolean
Does this method support variable length argument lists?
Does this method support variable length argument lists?
- Definition Classes
- MethodSymbolApi
- 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
- abstract def name: 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
- 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
- abstract def overrides: List[Universe.Symbol]
Returns all symbols overridden by this symbol.
Returns all symbols overridden by this symbol.
- Definition Classes
- SymbolApi
- 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 isNoSymbol
. Every other symbol has a chain of owners that ends in scala.reflect.api.Mirror.RootClass.- Definition Classes
- SymbolApi
- abstract def paramLists: List[List[Universe.Symbol]]
All parameter lists of the method.
All parameter lists of the method.
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())
).- Definition Classes
- MethodSymbolApi
- abstract def pos: Universe.Position
Position of the tree.
Position of the tree.
- Definition Classes
- SymbolApi
- 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
- abstract def returnType: Universe.Type
The return type of the method.
The return type of the method.
- Definition Classes
- MethodSymbolApi
- abstract def setter: Universe.Symbol
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.
- Definition Classes
- TermSymbolApi
- 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
- abstract def typeParams: List[Universe.Symbol]
For a polymorphic method, its type parameters, the empty list for all other methods
For a polymorphic method, its type parameters, the empty list for all other methods
- Definition Classes
- MethodSymbolApi
- abstract def typeSignature: Universe.Type
- abstract def typeSignatureIn(site: Universe.Type): Universe.Type
- abstract def allOverriddenSymbols: List[Universe.Symbol]
- 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.
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 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 paramss: List[List[Universe.Symbol]]
- Definition Classes
- MethodSymbolApi
- Annotations
- @deprecated
- Deprecated
(Since version 2.11.0) use
paramLists
instead- See also
paramLists The name ending with "ss" indicates that the result type is a list of lists.
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
- 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
ifisClass
is false.
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- final def asMethod: Universe.MethodSymbol
This symbol cast to a MethodSymbol.
This symbol cast to a MethodSymbol.
- Definition Classes
- MethodSymbolApi → SymbolApi
- Exceptions thrown
ScalaReflectionException
ifisMethod
is false.
- 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
ifisModule
is false.
- final def asTerm: Universe.TermSymbol with Universe.TermSymbolApi
This symbol cast to a TermSymbol.
This symbol cast to a TermSymbol.
- Definition Classes
- TermSymbolApi → SymbolApi
- Exceptions thrown
ScalaReflectionException
ifisTerm
is false.
- def asType: Universe.TypeSymbol
This symbol cast to a TypeSymbol.
This symbol cast to a TypeSymbol.
- Definition Classes
- SymbolApi
- Exceptions thrown
ScalaReflectionException
ifisType
is false.
- def clone(): AnyRef
- Attributes
- protected[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[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()
- 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
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final 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
- MethodSymbolApi → SymbolApi
- def isModule: Boolean
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.- 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.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
Used to provide a better error message for
asMethod
- Attributes
- protected
- Definition Classes
- TermSymbolApi → SymbolApi
- final 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 forNoSymbol
), eithersym.isTerm
is true orsym.isType
is true.- Definition Classes
- TermSymbolApi → SymbolApi
- 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 forNoSymbol
), eithersym.isTerm
is true orsym.isType
is true.- Definition Classes
- SymbolApi
- 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()
Inherited from Universe.<refinement>
Inherited from Universe.<refinement>
Inherited from Universe.MethodSymbolApi
Inherited from Universe.TermSymbolApi
Inherited from Universe.SymbolApi
Inherited from AnyRef
Inherited from Any
Method Symbol Members
TermSymbol Members
Symbol Basic Information
Symbol Type Tests
Symbol Conversions
Iteration Helpers
These methods enable collections-like operations on symbols.