scala.reflect.api.Symbols

# AbsSymbol

#### abstract class AbsSymbol extends AnyRef

Self Type
  Symbol
Source
  Symbols.scala

Linear Supertypes
AnyRef, Any
Ordering

1. Alphabetic
2. By inheritance

Inherited

1. Hide All
2. Show all

1. AbsSymbol
2. AnyRef
3. Any

Visibility

1. Public
2. All

### Instance Constructors

1. #### new AbsSymbol()

### Abstract Value Members

1. #### abstract def annotations: List[AnnotationInfo]

   A list of annotations attached to this Symbol.

2. #### 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`.

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

4. #### abstract def asTypeIn(site: Type): Type

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

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

6. #### abstract def enclosingClass: Symbol

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

7. #### abstract def enclosingMethod: Symbol

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

8. #### abstract def enclosingPackageClass: Symbol

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

9. #### 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.

10. #### abstract def fullName: String

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

11. #### abstract def hasAnnotation(sym: Symbol): Boolean

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

12. #### abstract def hasModifier(mod: Modifier): Boolean

    Does this symbol have given modifier?

13. #### abstract def id: Int

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

14. #### abstract def isAbstractType: Boolean

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

15. #### abstract def isAliasType: Boolean

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

16. #### abstract def isClass: Boolean

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

17. #### 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.

18. #### 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.

19. #### abstract def modifiers: Set[Modifier]

    The modifiers of this symbol

20. #### abstract def moduleClass: Symbol

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

21. #### abstract def name: Name

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

22. #### abstract def newNestedSymbol(name: Name, pos: Position, flags: Long): Symbol

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

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

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

25. #### abstract def selfType: Type

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

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

    Set symbol's annotations to given annotations `annots`.

27. #### 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

28. #### 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

29. #### abstract def thisPrefix: Type

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

30. #### 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.

31. #### 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. #### final def ==(arg0: AnyRef): Boolean

   Definition Classes
     AnyRef

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

6. #### 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`.

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

8. #### 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

9. #### 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

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

11. #### 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

12. #### 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

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

14. #### 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

15. #### 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

16. #### 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

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

    Definition Classes
      AnyRef

18. #### 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

19. #### final def wait(): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws()

20. #### final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws()

21. #### final def wait(arg0: Long): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws()

### Inherited from AnyRef

### Inherited from Any