Scala Reflection Library 2.13.16 - scala.reflect.api.Names
Keywords: Scala Reflection Library 2.13.16 scala.reflect.api.Names

Scala Reflection Library2.13.16 < Back


# Packages

-  package root
  Definition Classes
    root
-  package scala
  Definition Classes
    root
-  package reflect
  Definition Classes
    scala
-  package api

  EXPERIMENTAL

  EXPERIMENTAL

  The Scala Reflection API (located in scala-reflect.jar).

  In Scala 2.10.0, the Scala Reflection API and its implementation have an "experimental" status. This means that the API and the docs are not complete and can be changed in binary- and source-incompatible manner in 2.10.1. This also means that the implementation has some known issues.

  The following types are the backbone of the Scala Reflection API, and serve as a good starting point for information about Scala Reflection:

  - scala.reflect.api.Symbols
  - scala.reflect.api.Types
  - scala.reflect.api.Mirrors
  - scala.reflect.api.Universe

  For more information about Scala Reflection, see the Reflection Guide

  Definition Classes
    reflect
- Annotations
- Constants
- Exprs
- FlagSets
- ImplicitTags
- Internals
- JavaUniverse
- Liftables
- Mirror
- Mirrors
- Names
- Position
- Positions
- Printers
- Quasiquotes
- Scopes
- StandardDefinitions
- StandardLiftables
- StandardNames
- Symbols
- TreeCreator
- Trees
- TypeCreator
- TypeTags
- Types
- Universe

t

scala.reflect.api

# Names

###

#### trait Names extends AnyRef

EXPERIMENTAL

This trait defines `Name`s in Scala Reflection, and operations on them.

Names are simple wrappers for strings. Name has two subtypes TermName and TypeName which distinguish names of terms (like objects or members) and types. A term and a type of the same name can co-exist in an object.

To search for the `map` method (which is a term) declared in the `List` class, one can do:

    scala> typeOf[List[_]].member(TermName("map"))
    res0: reflect.runtime.universe.Symbol = method map

To search for a type member, one can follow the same procedure, using `TypeName` instead.

For more information about creating and using `Name`s, see the Reflection Guide: Annotations, Names, Scopes, and More

Source
  Names.scala

Linear Supertypes
AnyRef, Any
Known Subclasses
JavaUniverse, Universe, Universe
Type Hierarchy
Content Hierarchy

Ordering

1. Grouped
2. Alphabetic
3. By Inheritance

Inherited

1. Names
2. AnyRef
3. Any

Implicitly

1. by any2stringadd
2. by StringFormat
3. by Ensuring
4. by ArrowAssoc

1. Hide All
2. Show All

Visibility

1. Public
2. Protected

### Type Members

1.  abstract type Name >: Null <: NameApi

   The abstract type of names.

2.  abstract class NameApi extends AnyRef

   The API of Name instances.

3.  abstract type TermName >: Null <: TermNameApi with Name

   The abstract type of names representing types.

4.  trait TermNameApi extends AnyRef

   Has no special methods.

   Has no special methods. Is here to provides erased identity for `TermName`.

5.  abstract class TermNameExtractor extends AnyRef

   An extractor class to create and pattern match with syntax `TermName(s)`.

6.  abstract type TypeName >: Null <: TypeNameApi with Name

   The abstract type of names representing terms.

7.  trait TypeNameApi extends AnyRef

   Has no special methods.

   Has no special methods. Is here to provides erased identity for `TypeName`.

8.  abstract class TypeNameExtractor extends AnyRef

   An extractor class to create and pattern match with syntax `TypeName(s)`.

### Abstract Value Members

1.  abstract val TermName: TermNameExtractor

   The constructor/extractor for `TermName` instances.

2.  abstract val TypeName: TypeNameExtractor

   The constructor/extractor for `TypeName` instances.

3.  abstract def newTermName(s: String): TermName

   Create a new term name.

   Create a new term name.

   Annotations
     @deprecated
   Deprecated

     (Since version 2.11.0) use TermName instead

4.  abstract def newTypeName(s: String): TypeName

   Creates a new type name.

   Creates a new type name.

   Annotations
     @deprecated
   Deprecated

     (Since version 2.11.0) use TypeName instead

### Concrete Value Members

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
2.  final def ##: Int
   Definition Classes
     AnyRef → Any
3.  def +(other: String): String
   Implicit
     This member is added by an implicit conversion from Names toany2stringadd[Names] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (Names, B)
   Implicit
     This member is added by an implicit conversion from Names toArrowAssoc[Names] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()
5.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
6.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
7.  def clone(): AnyRef
   Attributes
     protected[lang]
   Definition Classes
     AnyRef
   Annotations
     @throws(classOf[java.lang.CloneNotSupportedException]) @native()
8.  def ensuring(cond: (Names) => Boolean, msg: => Any): Names
   Implicit
     This member is added by an implicit conversion from Names toEnsuring[Names] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
9.  def ensuring(cond: (Names) => Boolean): Names
   Implicit
     This member is added by an implicit conversion from Names toEnsuring[Names] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
10.  def ensuring(cond: Boolean, msg: => Any): Names
    Implicit
      This member is added by an implicit conversion from Names toEnsuring[Names] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
11.  def ensuring(cond: Boolean): Names
    Implicit
      This member is added by an implicit conversion from Names toEnsuring[Names] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
12.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
13.  def equals(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef → Any
14.  def finalize(): Unit
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.Throwable])
15.  final def getClass(): Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
16.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
17.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
18.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
19.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
20.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
21.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
22.  def toString(): String
    Definition Classes
      AnyRef → Any
23.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
24.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
25.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException]) @native()

### Deprecated Value Members

1.  def formatted(fmtstr: String): String
   Implicit
     This member is added by an implicit conversion from Names toStringFormat[Names] performed by method StringFormat in scala.Predef.
   Definition Classes
     StringFormat
   Annotations
     @deprecated @inline()
   Deprecated

     (Since version 2.12.16) Use `formatString.format(value)` instead of `value.formatted(formatString)`, or use the `f""` string interpolator. In Java 15 and later, `formatted` resolves to the new method in String which has reversed parameters.

2.  def stringToTermName(s: String): TermName

   A former implicit conversion from String to TermName.

   A former implicit conversion from String to TermName.

   This used to be an implicit conversion, enabling an alternative notation `"map": TermName` as opposed to `TermName("map")`. It is only kept for binary compatibility reasons, and should not be used anymore.

   Annotations
     @deprecated
   Deprecated

     (Since version 2.11.0) use `TermName(s)` instead

3.  def stringToTypeName(s: String): TypeName

   A former implicit conversion from String to TypeName.

   A former implicit conversion from String to TypeName.

   This used to be an implicit conversion, enabling an alternative notation `"List": TypeName` as opposed to `TypeName("List")`. It is only kept for binary compatibility reasons, and should not be used anymore.

   Annotations
     @deprecated
   Deprecated

     (Since version 2.11.0) use `TypeName(s)` instead

4.  def →[B](y: B): (Names, B)
   Implicit
     This member is added by an implicit conversion from Names toArrowAssoc[Names] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @deprecated
   Deprecated

     (Since version 2.13.0) Use `->` instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd fromNames to any2stringadd[Names]

### Inherited by implicit conversion StringFormat fromNames to StringFormat[Names]

### Inherited by implicit conversion Ensuring fromNames to Ensuring[Names]

### Inherited by implicit conversion ArrowAssoc fromNames to ArrowAssoc[Names]

### Names

### API

The methods available for each reflection entity, without the implementation. Since the reflection entities are later overridden by runtime reflection and macros, their API counterparts guarantee a minimum set of methods that are implemented.

### Extractors

Extractors provide the machinery necessary to allow pattern matching and construction of reflection entities that is similar to case classes, although the entities are only abstract types that are later overridden.

### Ungrouped