Trait

scala.reflect.api.Trees

StarApi

Related Doc: package Trees

Permalink

trait StarApi extends Universe.TermTreeApi

The API that all stars support

Self Type
Universe.Star
Source
Trees.scala
Linear Supertypes
Universe.TermTreeApi, Universe.TreeApi, Product, Equals, AnyRef, Any
Known Subclasses
Star
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StarApi
  2. TermTreeApi
  3. TreeApi
  4. Product
  5. Equals
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

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

    Permalink
    Definition Classes
    Equals

  2. abstract def canHaveAttrs: Boolean

    Permalink

    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.

    Definition Classes
    TreeApi

  3. abstract def children: List[Universe.Tree]

    Permalink

    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]

    Permalink

    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: StarApi.this.type

    Permalink

    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 elem: Universe.Tree

    Permalink

    The quantified pattern.

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

    Permalink

    Tests whether two trees are structurally equal.

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

    Definition Classes
    TreeApi

  8. abstract def exists(p: (Universe.Tree) ⇒ Boolean): Boolean

    Permalink

    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

  9. abstract def filter(f: (Universe.Tree) ⇒ Boolean): List[Universe.Tree]

    Permalink

    Find all subtrees matching predicate p.

    Find all subtrees matching predicate p. Same as withFilter

    Definition Classes
    TreeApi

  10. abstract def find(p: (Universe.Tree) ⇒ Boolean): Option[Universe.Tree]

    Permalink

    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

  11. abstract def forAll(p: (Universe.Tree) ⇒ Boolean): Boolean

    Permalink

    Do all parts of this tree satisfy predicate p?

    Do all parts of this tree satisfy predicate p?

    Definition Classes
    TreeApi

  12. abstract def foreach(f: (Universe.Tree) ⇒ Unit): Unit

    Permalink

    Apply f to each subtree

    Apply f to each subtree

    Definition Classes
    TreeApi

  13. abstract def isDef: Boolean

    Permalink

    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

  14. abstract def isEmpty: Boolean

    Permalink

    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.

    Definition Classes
    TreeApi
    See also

    canHaveAttrs

  15. abstract def isTerm: Boolean

    Permalink

    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

  16. abstract def isType: Boolean

    Permalink

    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

  17. abstract def nonEmpty: Boolean

    Permalink

    Is this tree not an empty tree?

    Is this tree not an empty tree?

    Definition Classes
    TreeApi
    See also

    isEmpty

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

    Permalink

    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

  19. abstract def pos: Universe.Position

    Permalink

    Position of the tree.

    Position of the tree.

    Definition Classes
    TreeApi

  20. abstract def productArity: Int

    Permalink
    Definition Classes
    Product

  21. abstract def productElement(n: Int): Any

    Permalink
    Definition Classes
    Product

  22. abstract def symbol: Universe.Symbol

    Permalink

    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
    TreeApi

  23. abstract def tpe: Universe.Type

    Permalink

    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

  24. abstract def withFilter(f: (Universe.Tree) ⇒ Boolean): List[Universe.Tree]

    Permalink

    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: Any): Boolean

    Permalink

    Test two objects for inequality.

    Test two objects for inequality.

    returns

    true if !(this == that), false otherwise.

    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink

    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

  3. def +(other: String): String

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

  4. def ->[B](y: B): (Universe.StarApi, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Universe.StarApi to ArrowAssoc[Universe.StarApi] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink

    The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

    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
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink

    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

    Permalink

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

    not specified by SLS as a member of AnyRef

  8. def ensuring(cond: (Universe.StarApi) ⇒ Boolean, msg: ⇒ Any): Universe.StarApi

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

  9. def ensuring(cond: (Universe.StarApi) ⇒ Boolean): Universe.StarApi

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

  10. def ensuring(cond: Boolean, msg: ⇒ Any): Universe.StarApi

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

  11. def ensuring(cond: Boolean): Universe.StarApi

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

  12. final def eq(arg0: AnyRef): Boolean

    Permalink

    Tests whether the argument (that) is a reference to the receiver object (this).

    Tests whether the argument (that) 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

  13. def equals(arg0: Any): Boolean

    Permalink

    The equality method for reference types.

    The equality method for reference types. Default implementation delegates to eq.

    See also equals in scala.Any.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Definition Classes
    AnyRef → Any

  14. def finalize(): Unit

    Permalink

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

    not specified by SLS as a member of AnyRef

  15. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Universe.StarApi to StringFormat[Universe.StarApi] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  16. final def getClass(): Class[_]

    Permalink

    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

  17. def hashCode(): Int

    Permalink

    The hashCode method for reference types.

    The hashCode method for reference types. See hashCode in scala.Any.

    returns

    the hash code value for this object.

    Definition Classes
    AnyRef → Any

  18. final def isInstanceOf[T0]: Boolean

    Permalink

    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

  19. final def ne(arg0: AnyRef): Boolean

    Permalink

    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

  20. final def notify(): Unit

    Permalink

    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

  21. final def notifyAll(): Unit

    Permalink

    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

  22. def productIterator: Iterator[Any]

    Permalink
    Definition Classes
    Product

  23. def productPrefix: String

    Permalink
    Definition Classes
    Product

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

    Permalink
    Definition Classes
    AnyRef

  25. def toString(): String

    Permalink

    Obtains string representation of a tree

    Obtains string representation of a tree

    returns

    a String representation of the object.

    Definition Classes
    TreeApi → AnyRef → Any

  26. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  28. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  29. def →[B](y: B): (Universe.StarApi, B)

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