scala.reflect.api.Symbols

SymbolApi

trait SymbolApi extends AnyRef

The API of symbols. The main source of information about symbols is the Symbols page.

Class Symbol defines isXXX test methods such as isPublic or isFinal, params and returnType methods for method symbols, baseClasses for class symbols and so on. Some of these methods don't make sense for certain subclasses of Symbol and return NoSymbol, Nil or other empty values.

Self Type
Universe.Symbol
Source
Symbols.scala
Linear Supertypes
Known Subclasses
ClassSymbol, ClassSymbolApi, FreeTermSymbol, FreeTermSymbolApi, FreeTypeSymbol, FreeTypeSymbolApi, MethodSymbol, MethodSymbolApi, ModuleSymbol, ModuleSymbolApi, SymbolContextApi, TermSymbol, TermSymbolApi, TypeSymbol, TypeSymbolApi
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Grouped
  2. Alphabetic
  3. By inheritance
Inherited
  1. SymbolApi
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. abstract type NameType >: Null <: Universe.Name

    The type of the symbol name.

    The type of the symbol name. Can be either TermName or TypeName depending on whether this is a TermSymbol or a TypeSymbol.

    Type name namespaces do not intersect with term name namespaces. This fact is reflected in different types for names of TermSymbol and TypeSymbol.

Abstract Value Members

  1. abstract def allOverriddenSymbols: List[Universe.Symbol]

    Returns all symbols overriden by this symbol.

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

    A list of annotations attached to this Symbol.

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

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

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

  6. abstract def fullName: String

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

  7. abstract def isAbstractOverride: Boolean

    Is this symbol labelled as "abstract override"?

  8. abstract def isErroneous: Boolean

    Does this symbol or its underlying type represent a typechecking error?

  9. abstract def isFinal: Boolean

    Is this symbol final?

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

  11. abstract def isImplicit: Boolean

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

  12. abstract def isJava: Boolean

    Is this symbol defined by Java?

  13. abstract def isLocal: Boolean

    Does this symbol represent a local declaration or definition?

    Does this symbol represent a local declaration or definition?

    If yes, either isPrivate or isProtected are guaranteed to be true. Local symbols can only be accessed from the same object instance.

    If yes, privateWithin might tell more about this symbol's visibility scope.

  14. abstract def isMacro: Boolean

    Is this symbol a macro?

  15. abstract def isOverride: Boolean

    Is this symbol overriding something?

  16. abstract def isPackage: Boolean

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

  17. abstract def isPackageClass: Boolean

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

  18. abstract def isParameter: Boolean

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

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

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

  21. abstract def isPublic: Boolean

    Does this symbol represent a public declaration or definition?

  22. abstract def isSpecialized: Boolean

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

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

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

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

  26. abstract def name: Universe.Name

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

  27. abstract def newClassSymbol(name: Universe.TypeName, pos: Universe.Position = NoPosition, flags: Universe.FlagSet = NoFlags): Universe.ClassSymbol

  28. abstract def newMethodSymbol(name: Universe.TermName, pos: Universe.Position = NoPosition, flags: Universe.FlagSet = NoFlags): Universe.MethodSymbol

  29. abstract def newModuleAndClassSymbol(name: Universe.Name, pos: Universe.Position = NoPosition, flags: Universe.FlagSet = NoFlags): (Universe.ModuleSymbol, Universe.ClassSymbol)

  30. abstract def newTermSymbol(name: Universe.TermName, pos: Universe.Position = NoPosition, flags: Universe.FlagSet = NoFlags): Universe.TermSymbol

  31. abstract def newTypeSymbol(name: Universe.TypeName, pos: Universe.Position = NoPosition, flags: Universe.FlagSet = NoFlags): Universe.TypeSymbol

  32. abstract def orElse(alt: ⇒ Universe.Symbol): Universe.Symbol

    Provides an alternate if symbol is a NoSymbol.

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

  34. abstract def privateWithin: Universe.Symbol

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

    Set when symbol has a modifier of the form private[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)

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

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

  36. abstract def typeSignature: 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 typeSignatureIn.

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

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

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Test two objects for inequality.

    Test two objects for inequality.

    returns

    true if !(this == that), false otherwise.

    Definition Classes
    Any
  3. final def ##(): Int

    Equivalent to x.hashCode except for boxed numeric types and null.

    Equivalent to x.hashCode except for boxed numeric types and null. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. For null returns a hashcode where null.hashCode throws a NullPointerException.

    returns

    a hash value consistent with ==

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from Universe.SymbolApi to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (Universe.SymbolApi, B)

    Implicit information
    This member is added by an implicit conversion from Universe.SymbolApi to ArrowAssoc[Universe.SymbolApi] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Test two objects for equality.

    Test two objects for equality. The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Definition Classes
    Any
  8. 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.

    Exceptions thrown
    ScalaReflectionException

    if isClass is false.

  9. def asFreeTerm: Universe.FreeTermSymbol

    This symbol cast to a free term symbol.

    This symbol cast to a free term symbol.

    Exceptions thrown
    ScalaReflectionException

    if isFreeTerm is false.

  10. def asFreeType: Universe.FreeTypeSymbol

    This symbol cast to a free type symbol.

    This symbol cast to a free type symbol.

    Exceptions thrown
    ScalaReflectionException

    if isFreeType is false.

  11. final def asInstanceOf[T0]: T0

    Cast the receiver object to be of type T0.

    Cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression 1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression List(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.

    returns

    the receiver object.

    Definition Classes
    Any
    Exceptions thrown
    ClassCastException

    if the receiver object is not an instance of the erasure of type T0.

  12. def asMethod: Universe.MethodSymbol

    This symbol cast to a MethodSymbol.

    This symbol cast to a MethodSymbol.

    Exceptions thrown
    ScalaReflectionException

    if isMethod is false.

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

    Exceptions thrown
    ScalaReflectionException

    if isModule is false.

  14. def asTerm: Universe.TermSymbol

    This symbol cast to a TermSymbol.

    This symbol cast to a TermSymbol.

    Exceptions thrown
    ScalaReflectionException

    if isTerm is false.

  15. def asType: Universe.TypeSymbol

    This symbol cast to a TypeSymbol.

    This symbol cast to a TypeSymbol.

    Exceptions thrown
    ScalaReflectionException

    if isType is false.

  16. def clone(): AnyRef

    Create a copy of the receiver object.

    Create a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

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

    not specified by SLS as a member of AnyRef

  17. def ensuring(cond: (Universe.SymbolApi) ⇒ Boolean, msg: ⇒ Any): Universe.SymbolApi

    Implicit information
    This member is added by an implicit conversion from Universe.SymbolApi to Ensuring[Universe.SymbolApi] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: (Universe.SymbolApi) ⇒ Boolean): Universe.SymbolApi

    Implicit information
    This member is added by an implicit conversion from Universe.SymbolApi to Ensuring[Universe.SymbolApi] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. def ensuring(cond: Boolean, msg: ⇒ Any): Universe.SymbolApi

    Implicit information
    This member is added by an implicit conversion from Universe.SymbolApi to Ensuring[Universe.SymbolApi] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  20. def ensuring(cond: Boolean): Universe.SymbolApi

    Implicit information
    This member is added by an implicit conversion from Universe.SymbolApi to Ensuring[Universe.SymbolApi] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  21. final def eq(arg0: AnyRef): Boolean

    Tests whether the argument (arg0) is a reference to the receiver object (this).

    Tests whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an equivalence relation on non-null instances of AnyRef, and has three additional properties:

    • It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false.
    • For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false.
    • null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    Definition Classes
    AnyRef
  22. def equals(arg0: Any): Boolean

    The equality method for reference types.

    The equality method for reference types. Default implementation delegates to eq.

    See also equals in scala.Any.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Definition Classes
    AnyRef → Any
  23. def finalize(): Unit

    Called by the garbage collector on the receiver object when there are no more references to the object.

    Called by the garbage collector on the receiver object when there are no more references to the object.

    The details of when and if the finalize method is invoked, as well as the interaction between finalize and non-local returns and exceptions, are all platform dependent.

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

    not specified by SLS as a member of AnyRef

  24. def formatted(fmtstr: String): String

    Returns string formatted according to given format string.

    Returns string formatted according to given format string. Format strings are as for String.format (@see java.lang.String.format).

    Implicit information
    This member is added by an implicit conversion from Universe.SymbolApi to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  25. final def getClass(): Class[_]

    A representation that corresponds to the dynamic class of the receiver object.

    A representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    Definition Classes
    AnyRef → Any
    Note

    not specified by SLS as a member of AnyRef

  26. def hashCode(): Int

    The hashCode method for reference types.

    The hashCode method for reference types. See hashCode in scala.Any.

    returns

    the hash code value for this object.

    Definition Classes
    AnyRef → Any
  27. def isClass: Boolean

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

  28. def isFreeTerm: Boolean

    Does this symbol represent a free term captured by reification? If yes, isTerm is also guaranteed to be true.

  29. def isFreeType: Boolean

    Does this symbol represent a free type captured by reification? If yes, isType is also guaranteed to be true.

  30. final def isInstanceOf[T0]: Boolean

    Test whether the dynamic type of the receiver object is T0.

    Test whether the dynamic type of the receiver object is T0.

    Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    Definition Classes
    Any
  31. def isMethod: Boolean

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

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

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

  34. def isOverloadedMethod: Boolean

    Used to provide a better error message for asMethod

    Used to provide a better error message for asMethod

    Attributes
    protected
  35. 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.isTerm is true.

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

  37. final def ne(arg0: AnyRef): Boolean

    Equivalent to !(this eq that).

    Equivalent to !(this eq that).

    returns

    true if the argument is not a reference to the receiver object; false otherwise.

    Definition Classes
    AnyRef
  38. final def notify(): Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Definition Classes
    AnyRef
    Note

    not specified by SLS as a member of AnyRef

  39. final def notifyAll(): Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    Definition Classes
    AnyRef
    Note

    not specified by SLS as a member of AnyRef

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

    Definition Classes
    AnyRef
  41. def toString(): String

    Creates a String representation of this object.

    Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.

    returns

    a String representation of the object.

    Definition Classes
    AnyRef → Any
  42. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. def [B](y: B): (Universe.SymbolApi, B)

    Implicit information
    This member is added by an implicit conversion from Universe.SymbolApi to ArrowAssoc[Universe.SymbolApi] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from Universe.SymbolApi to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (symbolApi: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from Universe.SymbolApi to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (symbolApi: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: Universe.SymbolApi

    Implicit information
    This member is added by an implicit conversion from Universe.SymbolApi to ArrowAssoc[Universe.SymbolApi] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (symbolApi: ArrowAssoc[Universe.SymbolApi]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: Universe.SymbolApi

    Implicit information
    This member is added by an implicit conversion from Universe.SymbolApi to Ensuring[Universe.SymbolApi] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (symbolApi: Ensuring[Universe.SymbolApi]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Universe.SymbolApi to StringAdd

Inherited by implicit conversion any2stringfmt from Universe.SymbolApi to StringFormat

Inherited by implicit conversion any2ArrowAssoc from Universe.SymbolApi to ArrowAssoc[Universe.SymbolApi]

Inherited by implicit conversion any2Ensuring from Universe.SymbolApi to Ensuring[Universe.SymbolApi]

Symbol Basic Information

Symbol Type Tests

Symbol Conversions

New Symbol Constructors

These methods construct new symbols owned by the current symbol.

Iteration Helpers

These methods enable collections-like operations on symbols.

Ungrouped