scala.reflect.base.Symbols

ModuleSymbolBase

trait ModuleSymbolBase extends TermSymbolBase

The base API that all module symbols support

Self Type
ModuleSymbol
Source
Symbols.scala
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ModuleSymbolBase
  2. TermSymbolBase
  3. SymbolBase
  4. AnyRef
  5. 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. final type NameType = TermName

    Term symbols have their names of type TermName.

    Term symbols have their names of type TermName.

    Definition Classes
    TermSymbolBaseSymbolBase

Abstract Value Members

  1. 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
    SymbolBase
  2. abstract def id: Int

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

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

    Definition Classes
    SymbolBase
  3. abstract def moduleClass: Symbol

    The class implicitly associated with the object definition.

    The class implicitly associated with the object definition. One can go back from a module class to the associated module symbol by inspecting its selfType.termSymbol.

  4. abstract def name: Name

    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
    SymbolBase
  5. abstract def newClassSymbol(name: TypeName, pos: Position = NoPosition, flags: FlagSet = NoFlags): ClassSymbol

    Definition Classes
    SymbolBase
  6. abstract def newMethodSymbol(name: TermName, pos: Position = NoPosition, flags: FlagSet = NoFlags): MethodSymbol

    Definition Classes
    SymbolBase
  7. abstract def newModuleAndClassSymbol(name: Name, pos: Position = NoPosition, flags: FlagSet = NoFlags): (ModuleSymbol, ClassSymbol)

    Definition Classes
    SymbolBase
  8. abstract def newTermSymbol(name: TermName, pos: Position = NoPosition, flags: FlagSet = NoFlags): TermSymbol

    Definition Classes
    SymbolBase
  9. abstract def newTypeSymbol(name: TypeName, pos: Position = NoPosition, flags: FlagSet = NoFlags): TypeSymbol

    Definition Classes
    SymbolBase
  10. 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.

    Definition Classes
    SymbolBase

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 ModuleSymbolBase to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (ModuleSymbolBase, B)

    Implicit information
    This member is added by an implicit conversion from ModuleSymbolBase to ArrowAssoc[ModuleSymbolBase] 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 asClassSymbol: ClassSymbol

    This symbol cast to a ClassSymbol representing a class or trait.

    This symbol cast to a ClassSymbol representing a class or trait. Returns ClassCastException if isClass is false.

    Definition Classes
    SymbolBase
  9. def asFreeTermSymbol: FreeTermSymbol

    This symbol cast to a free term symbol.

    This symbol cast to a free term symbol. Returns ClassCastException if isFreeTerm is false.

    Definition Classes
    SymbolBase
  10. def asFreeTypeSymbol: FreeTypeSymbol

    This symbol cast to a free type symbol.

    This symbol cast to a free type symbol. Returns ClassCastException if isFreeType is false.

    Definition Classes
    SymbolBase
  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 asMethodSymbol: MethodSymbol

    This symbol cast to a MethodSymbol.

    This symbol cast to a MethodSymbol. Returns ClassCastException if isMethod is false.

    Definition Classes
    SymbolBase
  13. final def asModuleSymbol: ModuleSymbol

    This symbol cast to a ModuleSymbol defined by an object definition.

    This symbol cast to a ModuleSymbol defined by an object definition. Returns ClassCastException if isModule is false.

    Definition Classes
    ModuleSymbolBaseSymbolBase
  14. final def asTermSymbol: TermSymbol

    This symbol cast to a TermSymbol.

    This symbol cast to a TermSymbol. Returns ClassCastException if isTerm is false.

    Definition Classes
    TermSymbolBaseSymbolBase
  15. def asTypeSymbol: TypeSymbol

    This symbol cast to a TypeSymbol.

    This symbol cast to a TypeSymbol. Returns ClassCastException if isType is false.

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

    not specified by SLS as a member of AnyRef

  17. def enclosingClass: Symbol

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

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

    Definition Classes
    SymbolBase
  18. def enclosingMethod: Symbol

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

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

    Definition Classes
    SymbolBase
  19. def ensuring(cond: (ModuleSymbolBase) ⇒ Boolean, msg: ⇒ Any): ModuleSymbolBase

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

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

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

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

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

  28. 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
  29. 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
    SymbolBase
  30. def isFreeTerm: Boolean

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

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

    Definition Classes
    SymbolBase
  31. def isFreeType: Boolean

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

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

    Definition Classes
    SymbolBase
  32. 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
  33. 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
    SymbolBase
  34. final 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.

    Definition Classes
    ModuleSymbolBaseSymbolBase
  35. 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.

    Definition Classes
    SymbolBase
  36. final def isTerm: Boolean

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

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

    Definition Classes
    TermSymbolBaseSymbolBase
  37. 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, either sym.isTerm is true or sym.isType is true.

    Definition Classes
    SymbolBase
  38. 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
  39. 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

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

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

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

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

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

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

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

Shadowed Implict Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from ModuleSymbolBase 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:
    (moduleSymbolBase: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from ModuleSymbolBase 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:
    (moduleSymbolBase: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: ModuleSymbolBase

    Implicit information
    This member is added by an implicit conversion from ModuleSymbolBase to ArrowAssoc[ModuleSymbolBase] 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:
    (moduleSymbolBase: ArrowAssoc[ModuleSymbolBase]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: ModuleSymbolBase

    Implicit information
    This member is added by an implicit conversion from ModuleSymbolBase to Ensuring[ModuleSymbolBase] 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:
    (moduleSymbolBase: Ensuring[ModuleSymbolBase]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from TermSymbolBase

Inherited from SymbolBase

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ModuleSymbolBase to StringAdd

Inherited by implicit conversion any2stringfmt from ModuleSymbolBase to StringFormat

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

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