scala.reflect.api.Trees

LabelDefApi

trait LabelDefApi extends Universe.DefTreeApi with Universe.TermTreeApi

The API that all label defs support

Self Type
Universe.LabelDef
Source
Trees.scala
Linear Supertypes
Universe.TermTreeApi, Universe.DefTreeApi, Universe.NameTreeApi, Universe.SymTreeApi, Universe.TreeApi, Product, Equals, AnyRef, Any
Known Subclasses
LabelDef
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. LabelDefApi
  2. TermTreeApi
  3. DefTreeApi
  4. NameTreeApi
  5. SymTreeApi
  6. TreeApi
  7. Product
  8. Equals
  9. AnyRef
  10. Any
Implicitly
  1. by StringAdd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def canEqual(that: Any): Boolean

    A method that should be called from every well-designed equals method that is open to be overridden in a subclass.

    A method that should be called from every well-designed equals method that is open to be overridden in a subclass. See Programming in Scala, Chapter 28 for discussion and design.

    that

    the value being probed for possible equality

    returns

    true if this instance can possibly equal that, otherwise false

    Definition Classes
    Equals
  2. abstract def canHaveAttrs: Boolean

    Can this tree carry attributes (i.

    Can this tree carry attributes (i.e. symbols, types or positions)? Typically the answer is yes, except for the EmptyTree null object and two special singletons: emptyValDef and pendingSuperCall.

    Definition Classes
    TreeApi
  3. abstract def children: List[Universe.Tree]

    The direct child trees of this tree.

    The direct child trees of this tree. EmptyTrees are always omitted. Lists are flattened.

    Definition Classes
    TreeApi
  4. abstract def collect[T](pf: PartialFunction[Universe.Tree, T]): List[T]

    Apply pf' to each subtree on which the function is defined and collect the results.

    Apply pf' to each subtree on which the function is defined and collect the results.

    Definition Classes
    TreeApi
  5. abstract def duplicate: LabelDefApi.this.type

    Make a copy of this tree, keeping all attributes, except that all positions are focused (so nothing in this tree will be found when searching by position).

    Make a copy of this tree, keeping all attributes, except that all positions are focused (so nothing in this tree will be found when searching by position).

    Definition Classes
    TreeApi
  6. abstract def equalsStructure(that: Universe.Tree): Boolean

    Tests whether two trees are structurall equal.

    Tests whether two trees are structurall equal. Note that == on trees is reference equality.

    Definition Classes
    TreeApi
  7. abstract def exists(p: (Universe.Tree) ⇒ Boolean): Boolean

    Is there exists a part of this tree which satisfies predicate p?

    Is there exists a part of this tree which satisfies predicate p?

    Definition Classes
    TreeApi
  8. abstract def filter(f: (Universe.Tree) ⇒ Boolean): List[Universe.Tree]

    Find all subtrees matching predicate p.

    Find all subtrees matching predicate p. Same as withFilter

    Definition Classes
    TreeApi
  9. abstract def find(p: (Universe.Tree) ⇒ Boolean): Option[Universe.Tree]

    Returns optionally first tree (in a preorder traversal) which satisfies predicate p, or None if none exists.

    Returns optionally first tree (in a preorder traversal) which satisfies predicate p, or None if none exists.

    Definition Classes
    TreeApi
  10. abstract def forAll(p: (Universe.Tree) ⇒ Boolean): Boolean

    Do all parts of this tree satisfy predicate p?

    Do all parts of this tree satisfy predicate p?

    Definition Classes
    TreeApi
  11. abstract def foreach(f: (Universe.Tree) ⇒ Unit): Unit

    Apply f to each subtree

    Apply f to each subtree

    Definition Classes
    TreeApi
  12. abstract def freeTerms: List[Universe.FreeTermSymbol]

    Extracts free term symbols from a tree that is reified or contains reified subtrees.

    Extracts free term symbols from a tree that is reified or contains reified subtrees.

    Definition Classes
    TreeApi
  13. abstract def freeTypes: List[Universe.FreeTypeSymbol]

    Extracts free type symbols from a tree that is reified or contains reified subtrees.

    Extracts free type symbols from a tree that is reified or contains reified subtrees.

    Definition Classes
    TreeApi
  14. abstract def isDef: Boolean

    Does this tree represent a definition? (of a method, of a class, etc)

    Does this tree represent a definition? (of a method, of a class, etc)

    Definition Classes
    TreeApi
  15. abstract def isEmpty: Boolean

    Is this tree one of the empty trees?

    Is this tree one of the empty trees?

    Empty trees are: the EmptyTree null object, TypeTree instances that don't carry a type and the special emptyValDef singleton.

    In the compiler the isEmpty check and the derived orElse method are mostly used as a check for a tree being a null object (EmptyTree for term trees and empty TypeTree for type trees).

    Unfortunately emptyValDef is also considered to be isEmpty, but this is deemed to be a conceptual mistake pending a fix in https://issues.scala-lang.org/browse/SI-6762.

    Definition Classes
    TreeApi
    See also

    canHaveAttrs

  16. abstract def isTerm: Boolean

    The canonical way to test if a Tree represents a term.

    The canonical way to test if a Tree represents a term.

    Definition Classes
    TreeApi
  17. abstract def isType: Boolean

    The canonical way to test if a Tree represents a type.

    The canonical way to test if a Tree represents a type.

    Definition Classes
    TreeApi
  18. abstract def name: Universe.TermName

    The underlying name.

    The underlying name. For example, the <List> part of Ident("List": TermName).

    Definition Classes
    LabelDefApiDefTreeApiNameTreeApi
  19. abstract def nonEmpty: Boolean

    Is this tree one of the empty trees?

    Is this tree one of the empty trees?

    Definition Classes
    TreeApi
    See also

    isEmpty

  20. abstract def orElse(alt: ⇒ Universe.Tree): Universe.Tree

    Provides an alternate if tree is empty

    Provides an alternate if tree is empty

    alt

    The alternate tree

    returns

    If this tree is non empty, this tree, otherwise alt.

    Definition Classes
    TreeApi
  21. abstract def params: List[Universe.Ident]

    Label's parameters - names that can be used in the body of the label.

    Label's parameters - names that can be used in the body of the label. See the example for scala.reflect.api.Trees#LabelDefExtractor.

  22. abstract def pos: Universe.Position

    Position of the tree.

    Position of the tree.

    Definition Classes
    TreeApi
  23. abstract def productArity: Int

    The size of this product.

    The size of this product.

    returns

    for a product A(x1, ..., xk), returns k

    Definition Classes
    Product
  24. abstract def productElement(n: Int): Any

    The nth element of this product, 0-based.

    The nth element of this product, 0-based. In other words, for a product A(x1, ..., xk), returns x(n+1) where 0 < n < k.

    n

    the index of the element to return

    returns

    the element n elements after the first element

    Definition Classes
    Product
    Exceptions thrown
    `IndexOutOfBoundsException`
  25. abstract def rhs: Universe.Tree

    The body of the label.

    The body of the label. See the example for scala.reflect.api.Trees#LabelDefExtractor.

  26. abstract def substituteSymbols(from: List[Universe.Symbol], to: List[Universe.Symbol]): Universe.Tree

    Substitute symbols in to for corresponding occurrences of references to symbols from in this type.

    Substitute symbols in to for corresponding occurrences of references to symbols from in this type.

    Definition Classes
    TreeApi
  27. abstract def substituteThis(clazz: Universe.Symbol, to: Universe.Tree): Universe.Tree

    Substitute given tree to for occurrences of nodes that represent C.this, where C referes to the given class clazz.

    Substitute given tree to for occurrences of nodes that represent C.this, where C referes to the given class clazz.

    Definition Classes
    TreeApi
  28. abstract def substituteTypes(from: List[Universe.Symbol], to: List[Universe.Type]): Universe.Tree

    Substitute types in to for corresponding occurrences of references to symbols from in this tree.

    Substitute types in to for corresponding occurrences of references to symbols from in this tree.

    Definition Classes
    TreeApi
  29. abstract def symbol: Universe.Symbol

    Symbol of the tree.

    Symbol of the tree.

    For most trees symbol is null. In SymTrees, it is overridden and implemented with a var, initialized to NoSymbol.

    Trees which are not SymTrees but which carry symbols do so by overriding def symbol to forward it elsewhere. Examples:

    • Super(qual, _) has qual's symbol,
    • Apply(fun, args) has fun's symbol,
    • TypeApply(fun, args) has fun's symbol,
    • AppliedTypeTree(tpt, args) has tpt's symbol,
    • TypeTree(tpe) has tpe's typeSymbol, if tpe != null.
    Definition Classes
    SymTreeApiTreeApi
  30. abstract def tpe: Universe.Type

    Type of the tree.

    Type of the tree.

    Upon creation most trees have their tpe set to null. Types are typically assigned to trees during typechecking. Some node factory methods set tpe immediately after creation.

    When the typechecker encounters a tree with a non-null tpe, it will assume it to be correct and not check it again. This means one has to be careful not to erase the tpe field of subtrees.

    Definition Classes
    TreeApi
  31. abstract def withFilter(f: (Universe.Tree) ⇒ Boolean): List[Universe.Tree]

    Find all subtrees matching predicate p.

    Find all subtrees matching predicate p. Same as filter

    Definition Classes
    TreeApi

Concrete Value Members

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

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

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

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

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

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

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

    Definition Classes
    Any
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  10. def ensuring(cond: (Universe.LabelDefApi) ⇒ Boolean, msg: ⇒ Any): Universe.LabelDefApi

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

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

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

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

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

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  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 Universe.LabelDefApi to StringFormat[Universe.LabelDefApi] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  19. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  24. def productIterator: Iterator[Any]

    An iterator over all the elements of this product.

    An iterator over all the elements of this product.

    returns

    in the default implementation, an Iterator[Any]

    Definition Classes
    Product
  25. def productPrefix: String

    A string used in the toString methods of derived classes.

    A string used in the toString methods of derived classes. Implementations may override this method to prepend a string prefix to the result of toString methods.

    returns

    in the default implementation, the empty string

    Definition Classes
    Product
  26. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  27. def toString(): String

    Obtains string representation of a tree

    Obtains string representation of a tree

    Definition Classes
    TreeApi → 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): (Universe.LabelDefApi, B)

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

Inherited from Universe.TermTreeApi

Inherited from Universe.DefTreeApi

Inherited from Universe.NameTreeApi

Inherited from Universe.SymTreeApi

Inherited from Universe.TreeApi

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion StringAdd from Universe.LabelDefApi to StringAdd[Universe.LabelDefApi]

Inherited by implicit conversion StringFormat from Universe.LabelDefApi to StringFormat[Universe.LabelDefApi]

Inherited by implicit conversion Ensuring from Universe.LabelDefApi to Ensuring[Universe.LabelDefApi]

Inherited by implicit conversion ArrowAssoc from Universe.LabelDefApi to ArrowAssoc[Universe.LabelDefApi]

Ungrouped