Scala Reflection Library2.12.9 < 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:
For more information about Scala Reflection, see the Reflection Guide
Definition Classes
reflect
trait Trees extends AnyRef
EXPERIMENTAL
EXPERIMENTAL
This trait defines the node types used in Scala abstract syntax trees (AST) and operations on them.
Trees are the basis for Scala's abstract syntax that is used to represent programs. They are also called abstract syntax trees and commonly abbreviated as ASTs.
In Scala reflection, APIs that produce or use Trees are:
- Annotations which use trees to represent their arguments, exposed in Annotation.scalaArgs.
- reify, a special method on scala.reflect.api.Universe that takes an expression and returns an AST which represents the expression.
- Macros and runtime compilation with toolboxes which both use trees as their program representation medium.
Trees are immutable, except for three fields pos, symbol, and tpe, which are assigned when a tree is typechecked to attribute it with the information gathered by the typechecker.
Examples
The following creates an AST representing a literal 5 in Scala source code:
```
Literal(Constant(5))
```
The following creates an AST representing print("Hello World"):
```
Apply(Select(Select(This(TypeName("scala")), TermName("Predef")), TermName("print")), List(Literal(Constant("Hello World"))))
```
The following creates an AST from a literal 5, and then uses showRaw to print it in a readable format.
```
import scala.reflect.runtime.universe.{ reify, showRaw }
print( showRaw( reify{5}.tree ) )` // prints Literal(Constant(5))
```
For more information about Trees, see the Reflection Guide: Symbols, Trees, Types.
Definition Classes
api
Alternative
AlternativeApi
AlternativeExtractor
Annotated
AnnotatedApi
AnnotatedExtractor
AppliedTypeTree
AppliedTypeTreeApi
AppliedTypeTreeExtractor
Apply
ApplyApi
ApplyExtractor
Assign
AssignApi
AssignExtractor
AssignOrNamedArg
AssignOrNamedArgApi
AssignOrNamedArgExtractor
Bind
BindApi
BindExtractor
Block
BlockApi
BlockExtractor
CaseDef
CaseDefApi
CaseDefExtractor
ClassDef
ClassDefApi
ClassDefExtractor
CompoundTypeTree
CompoundTypeTreeApi
CompoundTypeTreeExtractor
DefDef
DefDefApi
DefDefExtractor
DefTree
DefTreeApi
ExistentialTypeTree
ExistentialTypeTreeApi
ExistentialTypeTreeExtractor
Function
FunctionApi
FunctionExtractor
GenericApply
GenericApplyApi
Ident
IdentApi
IdentExtractor
If
IfApi
IfExtractor
ImplDef
ImplDefApi
Import
ImportApi
ImportExtractor
ImportSelector
ImportSelectorApi
ImportSelectorExtractor
LabelDef
LabelDefApi
LabelDefExtractor
Literal
LiteralApi
LiteralExtractor
Match
MatchApi
MatchExtractor
MemberDef
MemberDefApi
Modifiers
ModifiersApi
ModifiersExtractor
ModuleDef
ModuleDefApi
ModuleDefExtractor
NameTree
NameTreeApi
New
NewApi
NewExtractor
PackageDef
PackageDefApi
PackageDefExtractor
RefTree
RefTreeApi
RefTreeExtractor
Return
ReturnApi
ReturnExtractor
Select
SelectApi
SelectExtractor
SelectFromTypeTree
SelectFromTypeTreeApi
SelectFromTypeTreeExtractor
SingletonTypeTree
SingletonTypeTreeApi
SingletonTypeTreeExtractor
Star
StarApi
StarExtractor
Super
SuperApi
SuperExtractor
SymTree
SymTreeApi
Template
TemplateApi
TemplateExtractor
TermTree
TermTreeApi
This
ThisApi
ThisExtractor
Throw
ThrowApi
ThrowExtractor
Transformer
Traverser
Tree
TreeApi
TreeCopier
TreeCopierOps
Try
TryApi
TryExtractor
TypTree
TypTreeApi
TypeApply
TypeApplyApi
TypeApplyExtractor
TypeBoundsTree
TypeBoundsTreeApi
TypeBoundsTreeExtractor
TypeDef
TypeDefApi
TypeDefExtractor
TypeTree
TypeTreeApi
TypeTreeExtractor
Typed
TypedApi
TypedExtractor
UnApply
UnApplyApi
UnApplyExtractor
ValDef
ValDefApi
ValDefExtractor
ValOrDefDef
ValOrDefDefApi

scala.reflect.api.Trees

ValDefExtractor

abstract class ValDefExtractor extends AnyRef

An extractor class to create and pattern match with syntax ValDef(mods, name, tpt, rhs). This AST node corresponds to any of the following Scala code:

mods val name: tpt = rhs

mods var name: tpt = rhs

mods name: tpt = rhs // in signatures of function and method definitions

self: Bar => // self-types

If the type of a value is not specified explicitly (i.e. is meant to be inferred), this is expressed by having tpt set to TypeTree() (but not to an EmptyTree!).

Source: Trees.scala

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

ValDefExtractor
AnyRef
Any

Implicitly

by any2stringadd
by StringFormat
by Ensuring
by ArrowAssoc

Hide All
Show All

Visibility

Public
All

Instance Constructors

new ValDefExtractor()

Abstract Value Members

abstract def apply(mods: Universe.Modifiers, name: Universe.TermName, tpt: Universe.Tree, rhs: Universe.Tree): Universe.ValDef
abstract def unapply(valDef: Universe.ValDef): Option[(Universe.Modifiers, Universe.TermName, Universe.Tree, Universe.Tree)]

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

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

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

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

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

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

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

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

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

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

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def formatted(fmtstr: String): String

Implicit
This member is added by an implicit conversion from Universe.ValDefExtractor to StringFormat[Universe.ValDefExtractor] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@native()
final def isInstanceOf[T0]: Boolean

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
def →[B](y: B): (Universe.ValDefExtractor, B)

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

Deprecated Value Members

def apply(sym: Universe.Symbol)(implicit token: Universe.CompatToken): Universe.ValDef

Annotations
@deprecated
Deprecated
(Since version 2.11.0) use internal.valDef instead
See also
InternalApi.valDef
def apply(sym: Universe.Symbol, rhs: Universe.Tree)(implicit token: Universe.CompatToken): Universe.ValDef

Annotations
@deprecated
Deprecated
(Since version 2.11.0) use internal.valDef instead
See also
InternalApi.valDef

Packages

Examples

ValDefExtractor

abstract class ValDefExtractor extends AnyRef

Instance Constructors

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Universe.ValDefExtractor to any2stringadd[Universe.ValDefExtractor]

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

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

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

Ungrouped

Packages

Examples

ValDefExtractor 

abstract class ValDefExtractor extends AnyRef

Instance Constructors

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Universe.ValDefExtractor to any2stringadd[Universe.ValDefExtractor]

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

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

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

Ungrouped

ValDefExtractor