Packages

trait TreeApi extends Product

The API that all trees support. The main source of information about trees is the scala.reflect.api.Trees page.

Self Type
Universe.Tree
Source
Trees.scala
Linear Supertypes
Product, Equals, AnyRef, Any
Known Subclasses
ReferenceToBoxed, ReferenceToBoxedApi, Alternative, AlternativeApi, Annotated, AnnotatedApi, AppliedTypeTree, AppliedTypeTreeApi, Apply, ApplyApi, Assign, AssignApi, Bind, BindApi, Block, BlockApi, CaseDef, CaseDefApi, ClassDef, ClassDefApi, CompoundTypeTree, CompoundTypeTreeApi, DefDef, DefDefApi, DefTree, DefTreeApi, ExistentialTypeTree, ExistentialTypeTreeApi, Function, FunctionApi, GenericApply, GenericApplyApi, Ident, IdentApi, If, IfApi, ImplDef, ImplDefApi, Import, ImportApi, LabelDef, LabelDefApi, Literal, LiteralApi, Match, MatchApi, MemberDef, MemberDefApi, ModuleDef, ModuleDefApi, NameTree, NameTreeApi, NamedArg, NamedArgApi, New, NewApi, PackageDef, PackageDefApi, RefTree, RefTreeApi, Return, ReturnApi, Select, SelectApi, SelectFromTypeTree, SelectFromTypeTreeApi, SingletonTypeTree, SingletonTypeTreeApi, Star, StarApi, Super, SuperApi, SymTree, SymTreeApi, Template, TemplateApi, TermTree, TermTreeApi, This, ThisApi, Throw, ThrowApi, Tree, Try, TryApi, TypTree, TypTreeApi, TypeApply, TypeApplyApi, TypeBoundsTree, TypeBoundsTreeApi, TypeDef, TypeDefApi, TypeTree, TypeTreeApi, Typed, TypedApi, UnApply, UnApplyApi, ValDef, ValDefApi, ValOrDefDef, ValOrDefDefApi
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TreeApi
  2. Product
  3. Equals
  4. AnyRef
  5. 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

Abstract Value Members

  1. abstract def canEqual(that: Any): Boolean
    Definition Classes
    Equals
  2. abstract def canHaveAttrs: Boolean

    Can this tree carry attributes (i.e.

    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: noSelfType and pendingSuperCall.

  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.

  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.

  5. abstract def duplicate: TreeApi.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).

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

    Tests whether two trees are structurally equal.

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

  7. abstract def exists(p: (Universe.Tree) => Boolean): Boolean

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

  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

  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.

  10. abstract def forAll(p: (Universe.Tree) => Boolean): Boolean

    Do all parts of this tree satisfy predicate p?

  11. abstract def foreach(f: (Universe.Tree) => Unit): Unit

    Apply f to each subtree

  12. abstract def isDef: Boolean

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

  13. 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 and TypeTree instances that don't carry a type.

    See also

    canHaveAttrs

  14. abstract def isTerm: Boolean

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

  15. abstract def isType: Boolean

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

  16. abstract def nonEmpty: Boolean

    Is this tree not an empty tree?

    Is this tree not an empty tree?

    See also

    isEmpty

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

  18. abstract def pos: Universe.Position

    Position of the tree.

  19. abstract def productArity: Int
    Definition Classes
    Product
  20. abstract def productElement(n: Int): Any
    Definition Classes
    Product
  21. 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.
  22. 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.

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

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 Universe.TreeApi toany2stringadd[Universe.TreeApi] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Universe.TreeApi, B)
    Implicit
    This member is added by an implicit conversion from Universe.TreeApi toArrowAssoc[Universe.TreeApi] 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: (Universe.TreeApi) => Boolean, msg: => Any): Universe.TreeApi
    Implicit
    This member is added by an implicit conversion from Universe.TreeApi toEnsuring[Universe.TreeApi] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (Universe.TreeApi) => Boolean): Universe.TreeApi
    Implicit
    This member is added by an implicit conversion from Universe.TreeApi toEnsuring[Universe.TreeApi] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): Universe.TreeApi
    Implicit
    This member is added by an implicit conversion from Universe.TreeApi toEnsuring[Universe.TreeApi] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): Universe.TreeApi
    Implicit
    This member is added by an implicit conversion from Universe.TreeApi toEnsuring[Universe.TreeApi] 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. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Universe.TreeApi toStringFormat[Universe.TreeApi] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. def productElementName(n: Int): String
    Definition Classes
    Product
  23. def productElementNames: Iterator[String]
    Definition Classes
    Product
  24. def productIterator: Iterator[Any]
    Definition Classes
    Product
  25. def productPrefix: 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(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def →[B](y: B): (Universe.TreeApi, B)
    Implicit
    This member is added by an implicit conversion from Universe.TreeApi toArrowAssoc[Universe.TreeApi] 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 Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromUniverse.TreeApi to any2stringadd[Universe.TreeApi]

Inherited by implicit conversion StringFormat fromUniverse.TreeApi to StringFormat[Universe.TreeApi]

Inherited by implicit conversion Ensuring fromUniverse.TreeApi to Ensuring[Universe.TreeApi]

Inherited by implicit conversion ArrowAssoc fromUniverse.TreeApi to ArrowAssoc[Universe.TreeApi]

Ungrouped