scala.reflect.api.Symbols

AbsSymbol

trait AbsSymbol extends AbsSymbolInternal

Self Type
Symbol
Source
Symbols.scala
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. AbsSymbol
  2. AbsSymbolInternal
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringfmt
  2. by any2stringadd
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def alternatives: List[Symbol]

    The overloaded alternatives of this symbol

  2. abstract def annotations: List[AnnotationInfo]

    A list of annotations attached to this Symbol.

  3. abstract def asType: 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.

    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.asType is the type C[T].

    By contrast, C.typeSignature would be a type signature of form PolyType(ClassInfoType(...)) that describes type parameters, value parameters, parent types, and members of C.

    Definition Classes
    AbsSymbolInternal
  4. abstract def asTypeConstructor: Type

    The type constructor corresponding to this type symbol.

    The type constructor corresponding to this type symbol. This is different from asType in that type parameters are part of results of asType, but not of asTypeConstructor.

    Example: Given a class declaration class C[T] { ... } , that generates a symbol C. Then C.asType is the type C[T], but C.asTypeConstructor is C.

  5. abstract def asTypeIn(site: Type): Type

    A type reference that refers to this type symbol seen as a member of given type site.

  6. abstract def companionSymbol: 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

  7. abstract def enclosingClass: Symbol

    If this symbol is a class, this symbol; otherwise the next enclosing class, or NoSymbol if none exists.

  8. abstract def enclosingMethod: Symbol

    If this symbol is a method, this symbol; otherwise the next enclosing method, or NoSymbol if none exists.

  9. abstract def enclosingPackageClass: Symbol

    If this symbol is a package class, this symbol; otherwise the next enclosing package class, or NoSymbol if none exists.

  10. abstract def enclosingTopLevelClass: Symbol

    If this symbol is a top-level class, this symbol; otherwise the next enclosing top-level class, or NoSymbol if none exists.

  11. abstract def filter(cond: (Symbol) ⇒ Boolean): Symbol

    .

    ...

  12. abstract def fullName: String

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

  13. abstract def hasAnnotation(sym: Symbol): Boolean

    Whether this symbol carries an annotation for which the given symbol is its typeSymbol.

  14. abstract def hasModifier(mod: Modifier): Boolean

    Does this symbol have given modifier?

  15. abstract def id: Int

    An id number which is unique for all symbols in this universe

  16. abstract def isAbstractType: Boolean

    Does this symbol represent the definition of an abstract type? If yes, isType is also guaranteed to be true.

  17. abstract def isAliasType: Boolean

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

  18. abstract def isClass: Boolean

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

  19. abstract def isContravariant: Boolean

    Is the type parameter represented by this symbol contravariant?

  20. abstract def isCovariant: Boolean

    Is the type parameter represented by this symbol contravariant?

  21. abstract def isDerivedValueClass: Boolean

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

  22. abstract def isErroneous: Boolean

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

  23. abstract def isExistential: Boolean

    Does this symbol represent an existentially bound type? If yes, isType is also guaranteed to be true.

  24. abstract def isFreeTerm: Boolean

    Does this symbol represent a free term captured by reification?

  25. abstract def isFreeType: Boolean

    Does this symbol represent a free type captured by reification?

    Does this symbol represent a free type captured by reification?

    Definition Classes
    AbsSymbolInternal
  26. abstract def isMethod: Boolean

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

  27. abstract def isOverloaded: Boolean

    Is this symbol an overloaded method?

  28. abstract def isPackage: Boolean

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

  29. abstract def isPackageClass: Boolean

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

  30. abstract def isPrimitiveValueClass: Boolean

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

  31. abstract def isSkolem: Boolean

    Does this symbol represent the definition of a skolem? Skolems are used during typechecking to represent type parameters viewed from inside their scopes.

    Does this symbol represent the definition of a skolem? Skolems are used during typechecking to represent type parameters viewed from inside their scopes. If yes, isType is also guaranteed to be true.

    Definition Classes
    AbsSymbolInternal
  32. abstract def isTerm: Boolean

    Does this symbol represent the definition of term? Note that every symbol is either a term or a type.

    Does this symbol represent the definition of term? Note that every symbol is either a term or a type. So for every symbol sym, either sym.isTerm is true or sym.isType is true.

  33. abstract def isType: Boolean

    Does this symbol represent the definition of type? Note that every symbol is either a term or a type.

    Does this symbol represent the definition of type? Note that every symbol is either a term or a type. So for every symbol sym, either sym.isTerm is true or sym.isType is true.

  34. abstract def kind: String

    The kind of this symbol; used for debugging

    The kind of this symbol; used for debugging

    Definition Classes
    AbsSymbolInternal
  35. abstract def modifiers: Set[Modifier]

    The modifiers of this symbol

  36. abstract def moduleClass: Symbol

    If symbol is an object definition, its implied associated class, otherwise NoSymbol

  37. abstract def name: Name

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

  38. abstract def newNestedSymbol(name: Name, pos: Position, flags: Long, isClass: Boolean): Symbol

    A fresh symbol with given name name, position pos and flags flags that has the current symbol as its owner.

    A fresh symbol with given name name, position pos and flags flags that has the current symbol as its owner.

    Definition Classes
    AbsSymbolInternal
  39. abstract def orElse[T](alt: ⇒ Symbol): Symbol

    .

    ...

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

  41. abstract def pos: Position

    The position of this symbol

  42. abstract def privateWithin: 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: hasFlag(PRIVATE) && (privateWithin == NoSymbol) java package: !hasFlag(PRIVATE | PROTECTED) && (privateWithin == enclosingPackage) java protected: hasFlag(PROTECTED) && (privateWithin == enclosingPackage) java public: !hasFlag(PRIVATE | PROTECTED) && (privateWithin == NoSymbol)

  43. abstract def resolveOverloaded(pre: Type = NoPrefix, targs: Seq[Type] = List(), actuals: Seq[Type]): Symbol

  44. abstract def selfType: Type

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

  45. abstract def setAnnotations(annots: AnnotationInfo*): AbsSymbol.this.type

    Set symbol's annotations to given annotations annots.

    Set symbol's annotations to given annotations annots.

    Definition Classes
    AbsSymbolInternal
  46. abstract def setInternalFlags(flags: Long): AbsSymbol.this.type

    Low-level operation to set the symbol's flags

    Low-level operation to set the symbol's flags

    returns

    the symbol itself

    Definition Classes
    AbsSymbolInternal
  47. abstract def setTypeSignature(tpe: Type): AbsSymbol.this.type

    Set symbol's type signature to given type

    Set symbol's type signature to given type

    returns

    the symbol itself

    Definition Classes
    AbsSymbolInternal
  48. abstract def suchThat(cond: (Symbol) ⇒ Boolean): Symbol

    .

    ...

  49. abstract def thisPrefix: Type

    If this symbol is a class, the type C.this, otherwise NoPrefix.

  50. abstract def typeSignature: Type

    The type signature of this symbol.

    The type signature of this symbol. Note if the symbol is a member of a class, one almost always is interested in typeSignatureIn with a site type instead.

    Definition Classes
    AbsSymbolInternal
  51. abstract def typeSignatureIn(site: Type): 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 AbsSymbol to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (AbsSymbol, B)

    Implicit information
    This member is added by an implicit conversion from AbsSymbol to ArrowAssoc[AbsSymbol] 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. 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.

  9. 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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
    Note

    not specified by SLS as a member of AnyRef

  10. def ensuring(cond: (AbsSymbol) ⇒ Boolean, msg: ⇒ Any): AbsSymbol

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

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

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

    Implicit information
    This member is added by an implicit conversion from AbsSymbol to Ensuring[AbsSymbol] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. 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
  15. 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 Any.

    returns

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

    Definition Classes
    AnyRef → Any
  16. 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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
    Note

    not specified by SLS as a member of AnyRef

  17. 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 AbsSymbol to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. 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

  19. def hashCode(): Int

    The hashCode method for reference types.

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

    returns

    the hash code value for this object.

    Definition Classes
    AnyRef → Any
  20. 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
  21. 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
  22. 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

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

  24. val self: Any

    Implicit information
    This member is added by an implicit conversion from AbsSymbol to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
  25. val self: Any

    Implicit information
    This member is added by an implicit conversion from AbsSymbol to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  26. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  27. 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
  28. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()
  31. def [B](y: B): (AbsSymbol, B)

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

Deprecated Value Members

  1. def x: AbsSymbol

    Implicit information
    This member is added by an implicit conversion from AbsSymbol to ArrowAssoc[AbsSymbol] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: AbsSymbol

    Implicit information
    This member is added by an implicit conversion from AbsSymbol to Ensuring[AbsSymbol] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from AbsSymbolInternal

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringfmt from AbsSymbol to StringFormat

Inherited by implicit conversion any2stringadd from AbsSymbol to StringAdd

Inherited by implicit conversion any2ArrowAssoc from AbsSymbol to ArrowAssoc[AbsSymbol]

Inherited by implicit conversion any2Ensuring from AbsSymbol to Ensuring[AbsSymbol]