Scaladoc for scala.reflect.generic.Trees

Inherited

Hide All
Show all

AnyRef
Any

Visibility

Public
All

Type Members

class AbsTreePrinter extends AnyRef

attributes: abstract
class AbsTypeTree extends Tree with TypTree

A synthetic term holding an arbitrary type.
class Alternative(trees: List[Tree]) extends Tree with TermTree with Product

Alternatives of patterns, eliminated by TransMatch, except for occurrences in encoded Switch stmt (=remaining Match(CaseDef(.
class Annotated(annot: Tree, arg: Tree) extends Tree with Product

A tree that has an annotation attached to it.
class AppliedTypeTree(tpt: Tree, args: List[Tree]) extends Tree with TypTree with Product

Applied type <tpt> [ <args> ], eliminated by RefCheck
class Apply(fun: Tree, args: List[Tree]) extends GenericApply with Product

Value application
class ApplyDynamic(qual: Tree, args: List[Tree]) extends Tree with TermTree with SymTree with Product

Dynamic value application.
class ArrayValue(elemtpt: Tree, elems: List[Tree]) extends Tree with TermTree with Product

Array of expressions, needs to be translated in backend,
class Assign(lhs: Tree, rhs: Tree) extends Tree with TermTree with Product

Assignment
class BackQuotedIdent extends Ident
class Bind(name: Name, body: Tree) extends DefTree with Product

Bind of a variable to a rhs pattern, eliminated by TransMatch
class Block(stats: List[Tree], expr: Tree) extends Tree with TermTree with Product

Block of expressions (semicolon separated expressions)
class CaseDef(pat: Tree, guard: Tree, body: Tree) extends Tree with Product

Case clause in a pattern match, eliminated by TransMatch (except for occurrences in switch statements)
class ClassDef(mods: Modifiers, name: Name, tparams: List[TypeDef], impl: Template) extends ImplDef with Product

Class definition
class CompoundTypeTree(templ: Template) extends Tree with TypTree with Product

Intersection type <parent1> with .
class DefDef(mods: Modifiers, name: Name, tparams: List[TypeDef], vparamss: List[List[ValDef]], tpt: Tree, rhs: Tree) extends ValOrDefDef with Product

Method definition
class DefTree extends Tree with SymTree

attributes: abstract
class ExistentialTypeTree(tpt: Tree, whereClauses: List[Tree]) extends Tree with TypTree with Product
class Function(vparams: List[ValDef], body: Tree) extends Tree with TermTree with SymTree with Product

Anonymous function, eliminated by analyzer
class GenericApply extends Tree with TermTree

attributes: abstract
class Ident(name: Name) extends Tree with RefTree with Product

Identifier <name>
class If(cond: Tree, thenp: Tree, elsep: Tree) extends Tree with TermTree with Product

Conditional expression
class ImplDef extends MemberDef

attributes: abstract
class Import(expr: Tree, selectors: List[ImportSelector]) extends Tree with SymTree with Product

Import clause
class ImportSelector(name: Name, namePos: Int, rename: Name, renamePos: Int) extends Product

Import selector
class LabelDef(name: Name, params: List[Ident], rhs: Tree) extends DefTree with TermTree with Product

Labelled expression - the symbols in the array (must be Idents!) are those the label takes as argument
class Literal(value: Constant) extends Tree with TermTree with Product

Literal
class Match(selector: Tree, cases: List[CaseDef]) extends Tree with TermTree with Product

Pattern matching expression (before TransMatch) Switch statements (after TransMatch)
class MemberDef extends DefTree

attributes: abstract
class Modifiers(flags: Long, privateWithin: Name, annotations: List[Tree], positions: Map[Long, Position]) extends Product

no summary matey
class ModuleDef(mods: Modifiers, name: Name, impl: Template) extends ImplDef with Product

Singleton object definition
class New(tpt: Tree) extends Tree with TermTree with Product

Object instantiation One should always use factory method below to build a user level new.
class PackageDef(pid: RefTree, stats: List[Tree]) extends MemberDef with Product

Package clause
trait RefTree extends Tree with SymTree
class Return(expr: Tree) extends Tree with TermTree with SymTree with Product

Return expression
class Select(qualifier: Tree, name: Name) extends Tree with RefTree with Product

Designator <qualifier> .
class SelectFromArray(qualifier: Tree, name: Name, erasure: Type) extends Tree with TermTree with RefTree with Product

Array selection <qualifier> .
class SelectFromTypeTree(qualifier: Tree, name: Name) extends Tree with TypTree with RefTree with Product

Type selection <qualifier> # <name>, eliminated by RefCheck
class SingletonTypeTree(ref: Tree) extends Tree with TypTree with Product

Singleton type, eliminated by RefCheck
class Star(elem: Tree) extends Tree with TermTree with Product

Repetition of pattern, eliminated by TransMatch
class Super(qual: Name, mix: Name) extends Tree with TermTree with SymTree with Product

Super reference
trait SymTree extends Tree
class Template(parents: List[Tree], self: ValDef, body: List[Tree]) extends Tree with SymTree with Product

Instantiation template of a class or trait
trait TermTree extends Tree
class This(qual: Name) extends Tree with TermTree with SymTree with Product

Self reference
class Throw(expr: Tree) extends Tree with TermTree with Product

Throw expression
class Traverser extends AnyRef
class Tree extends Product

attributes: abstract
class Try(block: Tree, catches: List[CaseDef], finalizer: Tree) extends Tree with TermTree with Product
trait TypTree extends Tree

A tree for a type.
class TypeApply(fun: Tree, args: List[Tree]) extends GenericApply with Product

Type application
class TypeBoundsTree(lo: Tree, hi: Tree) extends Tree with TypTree with Product
class TypeDef(mods: Modifiers, name: Name, tparams: List[TypeDef], rhs: Tree) extends MemberDef with Product

Abstract type, type parameter, or type alias
type TypeTree <: AbsTypeTree

attributes: abstract
class TypeTreeExtractor extends AnyRef

attributes: abstract
class Typed(expr: Tree, tpt: Tree) extends Tree with TermTree with Product

Type annotation, eliminated by explicit outer
class UnApply(fun: Tree, args: List[Tree]) extends Tree with TermTree with Product
class ValDef(mods: Modifiers, name: Name, tpt: Tree, rhs: Tree) extends ValOrDefDef with Product

Value definition
class ValOrDefDef extends MemberDef

attributes: abstract

Value Members

def !=(arg0: AnyRef): Boolean

attributes: final
definition classes: AnyRef
def !=(arg0: Any): Boolean

o != arg0 is the same as !(o == (arg0)).

o != arg0 is the same as !(o == (arg0)).
arg0
the object to compare against this object for dis-equality.
returns
false if the receiver object is equivalent to the argument; true otherwise.
attributes: final
definition classes: Any
def ##(): Int

attributes: final
definition classes: AnyRef → Any
def $asInstanceOf[T0](): T0

attributes: final
definition classes: AnyRef
def $isInstanceOf[T0](): Boolean

attributes: final
definition classes: AnyRef
def ==(arg0: AnyRef): Boolean

o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).
arg0
the object to compare against this object for equality.
returns
true if the receiver object is equivalent to the argument; false otherwise.
attributes: final
definition classes: AnyRef
def ==(arg0: Any): Boolean

o == arg0 is the same as o.equals(arg0).

o == arg0 is the same as o.equals(arg0).
arg0
the object to compare against this object for equality.
returns
true if the receiver object is equivalent to the argument; false otherwise.
attributes: final
definition classes: Any
object EmptyTree extends Tree with TermTree with Product

The empty tree
def Literal(value: Any): Literal
def Modifiers(flags: Long): Modifiers
def Modifiers(flags: Long, privateWithin: Name): Modifiers
lazy val NoMods: Modifiers
val TypeTree: TypeTreeExtractor

attributes: abstract
def asInstanceOf[T0]: T0

This method is used to cast the receiver object to be of type T0.

This method is used to 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 expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(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 typed.
returns
the receiver object.
attributes: final
definition classes: Any
def clone(): AnyRef

This method creates and returns a copy of the receiver object.

This method creates and returns 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
definition classes: AnyRef
def eq(arg0: AnyRef): Boolean

This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

This method is used to test whether the argument (arg0) is a reference to the receiver object (this).
The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.
Additionally, the eq method has three other 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).
arg0
the object to compare against this object for reference equality.
returns
true if the argument is a reference to the receiver object; false otherwise.
attributes: final
definition classes: AnyRef
def equals(arg0: Any): Boolean

This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.
The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).
arg0
the object to compare against this object for equality.
returns
true if the receiver object is equivalent to the argument; false otherwise.
definition classes: AnyRef → Any
def finalize(): Unit

This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.
The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.
attributes: protected
definition classes: AnyRef
def getClass(): java.lang.Class[_ <: java.lang.Object]

Returns a representation that corresponds to the dynamic class of the receiver object.

Returns 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.
attributes: final
definition classes: AnyRef
def hashCode(): Int

Returns a hash code value for the object.

Returns a hash code value for the object.
The default hashing algorithm is platform dependent.
Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.
returns
the hash code value for the object.
definition classes: AnyRef → Any
def isInstanceOf[T0]: Boolean

This method is used to test whether the dynamic type of the receiver object is T0.

This method is used to test whether the dynamic type of the receiver object is T0.
Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.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 requested typed.
returns
true if the receiver object is an instance of erasure of type T0; false otherwise.
attributes: final
definition classes: Any
def ne(arg0: AnyRef): Boolean

o.ne(arg0) is the same as !(o.eq(arg0)).

o.ne(arg0) is the same as !(o.eq(arg0)).
arg0
the object to compare against this object for reference dis-equality.
returns
false if the argument is not a reference to the receiver object; true otherwise.
attributes: final
definition classes: AnyRef
def newTreePrinter(out: PrintWriter): AbsTreePrinter

attributes: abstract
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.
attributes: final
definition classes: AnyRef
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.
attributes: final
definition classes: AnyRef
def synchronized[T0](arg0: T0): T0

attributes: final
definition classes: AnyRef
def toString(): String

Returns a string representation of the object.

Returns a string representation of the object.
The default representation is platform dependent.
returns
a string representation of the object.
definition classes: AnyRef → Any
def wait(): Unit

attributes: final
definition classes: AnyRef
def wait(arg0: Long, arg1: Int): Unit

attributes: final
definition classes: AnyRef
def wait(arg0: Long): Unit

attributes: final
definition classes: AnyRef

Trees

trait Trees extends AnyRef

Type Members

type TypeTree <: AbsTypeTree

Value Members

def !=(arg0: AnyRef): Boolean

def !=(arg0: Any): Boolean

def ##(): Int

def $asInstanceOf[T0](): T0

def $isInstanceOf[T0](): Boolean

def ==(arg0: AnyRef): Boolean

def ==(arg0: Any): Boolean

def Literal(value: Any): Literal

def Modifiers(flags: Long): Modifiers

def Modifiers(flags: Long, privateWithin: Name): Modifiers

lazy val NoMods: Modifiers

val TypeTree: TypeTreeExtractor

def asInstanceOf[T0]: T0

def clone(): AnyRef

def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def getClass(): java.lang.Class[_ <: java.lang.Object]

def hashCode(): Int

def isInstanceOf[T0]: Boolean

def ne(arg0: AnyRef): Boolean

def newTreePrinter(out: PrintWriter): AbsTreePrinter

def notify(): Unit

def notifyAll(): Unit

def synchronized[T0](arg0: T0): T0

def toString(): String

def wait(): Unit

def wait(arg0: Long, arg1: Int): Unit

def wait(arg0: Long): Unit