scala.reflect.internal.Trees

LabelDef

case class LabelDef(name: TermName, params: List[Ident], rhs: Tree) extends DefTree with TermTree with LabelDefApi with Product with Serializable

A labelled expression. Not expressible in language syntax, but generated by the compiler to simulate while/do-while loops, and also by the pattern matcher.

The label acts much like a nested function, where params represents the incoming parameters. The symbol given to the LabelDef should have a MethodType, as if it were a nested function.

Jumps are apply nodes attributed with a label's symbol. The arguments from the apply node will be passed to the label and assigned to the Idents.

Forward jumps within a block are allowed.

Definition Classes
TreesTreesTrees
Source
Trees.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. LabelDef
  2. Serializable
  3. Serializable
  4. LabelDefApi
  5. TermTree
  6. TermTreeApi
  7. DefTree
  8. DefTreeApi
  9. NameTree
  10. NameTreeApi
  11. SymTree
  12. SymTreeContextApi
  13. SymTreeApi
  14. Tree
  15. TreeContextApiImpl
  16. TreeContextApi
  17. TreeApi
  18. TreeBase
  19. Product
  20. Equals
  21. AnyRef
  22. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new LabelDef(name: TermName, params: List[Ident], rhs: Tree)

Value Members

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

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

    Test two objects for inequality.

    Test two objects for inequality.

    returns

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

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

    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
  4. def +(other: String): String

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

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

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

    Test two objects for equality.

    Test two objects for equality. 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
    Any
  8. def addAttachment(attachment: Any): LabelDef.this.type

    .

    ...

    Definition Classes
    TreeTreeContextApi
  9. final def asInstanceOf[T0]: T0

    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.

  10. def attachments: Attachments { type Pos = Trees.this.Position }

    .

    ...

    Definition Classes
    TreeTreeContextApi
  11. def changeOwner(pairs: (Symbol, Symbol)*): Tree

    Definition Classes
    TreeContextApiImpl
  12. def children: List[Tree]

    The direct child trees of this tree.

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

    Definition Classes
    TreeContextApiImplTreeApi
  13. def clone(): AnyRef

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

    not specified by SLS as a member of AnyRef

  14. def collect[T](pf: PartialFunction[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
    TreeContextApiImplTreeApi
  15. def correspondsStructure(that: Tree)(f: (Tree, Tree) ⇒ Boolean): Boolean

    Definition Classes
    TreeContextApiImpl
  16. def defineType(tp: Type): LabelDef.this.type

    Like setType, but if this is a previously empty TypeTree that fact is remembered so that resetAllAttrs will snap back.

    Like setType, but if this is a previously empty TypeTree that fact is remembered so that resetAllAttrs will snap back.

    Definition Classes
    TreeTreeContextApi
  17. def duplicate: LabelDef.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
    TreeTreeApi
  18. def ensuring(cond: (LabelDef) ⇒ Boolean, msg: ⇒ Any): LabelDef

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

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

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

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

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

    Tests whether the argument (arg0) 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
  23. def equals(that: Any): Boolean

    The universal equality method defined in AnyRef.

    The universal equality method defined in AnyRef.

    that

    the object to compare against this object for equality.

    returns

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

    Definition Classes
    TreeEquals → AnyRef → Any
  24. def equalsStructure(that: 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
    TreeContextApiImplTreeApi
  25. def exists(p: (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
    TreeContextApiImplTreeApi
  26. def filter(f: (Tree) ⇒ Boolean): List[Tree]

    Find all subtrees matching predicate p.

    Find all subtrees matching predicate p. Same as withFilter

    Definition Classes
    TreeContextApiImplTreeApi
  27. def finalize(): Unit

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

    not specified by SLS as a member of AnyRef

  28. def find(p: (Tree) ⇒ Boolean): Option[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
    TreeContextApiImplTreeApi
  29. def forAll(p: (Tree) ⇒ Boolean): Boolean

    Do all parts of this tree satisfy predicate p?

    Do all parts of this tree satisfy predicate p?

    Definition Classes
    TreeContextApiImplTreeApi
  30. def foreach(f: (Tree) ⇒ Unit): Unit

    Apply f to each subtree

    Apply f to each subtree

    Definition Classes
    TreeContextApiImplTreeApi
  31. def foreachPartial(pf: PartialFunction[Tree, Tree]): Unit

    If pf is defined for a given subtree, call super.

    If pf is defined for a given subtree, call super.traverse(pf(tree)), otherwise super.traverse(tree).

    Definition Classes
    TreeContextApiImpl
  32. 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 LabelDef to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  33. def freeTerms: List[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
    TreeContextApiImplTreeApi
  34. def freeTypes: List[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
    TreeContextApiImplTreeApi
  35. final def getClass(): Class[_]

    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

  36. def hasSymbol: Boolean

    .

    ...

    Definition Classes
    SymTreeTreeTreeApi
  37. def hasSymbolWhich(f: (Symbol) ⇒ Boolean): Boolean

    Definition Classes
    TreeContextApiImpl
  38. def hashCode(): Int

    The hashCode method for reference types.

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

    returns

    the hash code value for this object.

    Definition Classes
    Tree → AnyRef → Any
  39. val id: Int

    Definition Classes
    Tree
  40. def isDef: Boolean

    .

    ...

    Definition Classes
    DefTreeTreeTreeBase
  41. def isEmpty: Boolean

    .

    ...

    Definition Classes
    TreeTreeBase
  42. def isErroneous: Boolean

    Definition Classes
    TreeContextApiImpl
  43. def isErrorTyped: Boolean

    Definition Classes
    TreeContextApiImpl
  44. final def isInstanceOf[T0]: Boolean

    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
  45. 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
    TreeTreeBase
  46. 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
    TreeTreeBase
  47. def isTyped: Boolean

    Definition Classes
    TreeContextApiImpl
  48. def modifyType(f: (Type) ⇒ Type): Tree

    Sets the tree's type to the result of the given function.

    Sets the tree's type to the result of the given function. If the type is null, it remains null - the function is not called.

    Definition Classes
    TreeContextApiImpl
  49. val name: TermName

    Definition Classes
    LabelDefLabelDefApiDefTreeDefTreeApiNameTreeNameTreeApi
  50. final def ne(arg0: AnyRef): Boolean

    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
  51. final 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.

    Definition Classes
    AnyRef
    Note

    not specified by SLS as a member of AnyRef

  52. final 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.

    Definition Classes
    AnyRef
    Note

    not specified by SLS as a member of AnyRef

  53. def orElse(alt: ⇒ Tree): 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
    TreeContextApiImplTreeApi
  54. val params: List[Ident]

    Definition Classes
    LabelDefLabelDefApi
  55. final def pos: Position

    .

    ...

    Definition Classes
    TreeTreeApi
    Annotations
    @inline()
  56. def pos_=(pos: Position): Unit

    .

    ...

    Definition Classes
    TreeTreeContextApi
  57. def removeAttachment[T](implicit arg0: ClassTag[T]): LabelDef.this.type

    .

    ...

    Definition Classes
    TreeTreeContextApi
  58. val rhs: Tree

    Definition Classes
    LabelDefLabelDefApi
  59. val self: Any

    Implicit information
    This member is added by an implicit conversion from LabelDef to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  60. val self: Any

    Implicit information
    This member is added by an implicit conversion from LabelDef to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
  61. def setPos(newpos: Position): LabelDef.this.type

    .

    ...

    Definition Classes
    TreeTreeContextApi
  62. def setSymbol(sym: Symbol): LabelDef.this.type

    .

    ...

    Definition Classes
    TreeTreeContextApi
  63. def setType(tp: Type): LabelDef.this.type

    Set tpe to give tp and return this.

    Set tpe to give tp and return this.

    Definition Classes
    TreeTreeContextApi
  64. def shallowDuplicate: Tree

    Definition Classes
    TreeContextApiImpl
  65. def shortClass: String

    Definition Classes
    TreeContextApiImpl
  66. def substituteSymbols(from: List[Symbol], to: List[Symbol]): 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
    TreeContextApiImplTreeApi
  67. def substituteThis(clazz: Symbol, to: Tree): 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
    TreeContextApiImplTreeApi
  68. def substituteTypes(from: List[Symbol], to: List[Type]): 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
    TreeContextApiImplTreeApi
  69. def summaryString: String

    When you want to know a little more than the class, but a lot less than the whole tree.

    When you want to know a little more than the class, but a lot less than the whole tree.

    Definition Classes
    TreeContextApiImpl
  70. var symbol: Symbol

    Note that symbol is fixed as null at this level.

    Note that symbol is fixed as null at this level. 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

    Attempting to set the symbol of a Tree which does not support it will induce an exception.

    Definition Classes
    SymTreeSymTreeContextApiSymTreeApiTreeTreeApi
  71. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  72. def toString(): String

    Obtains string representation of a tree

    Obtains string representation of a tree

    returns

    a String representation of the object.

    Definition Classes
    TreeBase → AnyRef → Any
  73. final def tpe: Type

    .

    ...

    Definition Classes
    TreeTreeApi
    Annotations
    @inline()
  74. def tpe_=(t: Type): Unit

    .

    ...

    Definition Classes
    TreeTreeContextApi
  75. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()
  78. def withFilter(f: (Tree) ⇒ Boolean): List[Tree]

    Find all subtrees matching predicate p.

    Find all subtrees matching predicate p. Same as filter

    Definition Classes
    TreeContextApiImplTreeApi
  79. def [B](y: B): (LabelDef, B)

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

Deprecated Value Members

  1. def x: LabelDef

    Implicit information
    This member is added by an implicit conversion from LabelDef to ArrowAssoc[LabelDef] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: LabelDef

    Implicit information
    This member is added by an implicit conversion from LabelDef to Ensuring[LabelDef] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Serializable

Inherited from Serializable

Inherited from LabelDefApi

Inherited from TermTree

Inherited from TermTreeApi

Inherited from DefTree

Inherited from DefTreeApi

Inherited from NameTree

Inherited from NameTreeApi

Inherited from SymTree

Inherited from SymTreeContextApi

Inherited from SymTreeApi

Inherited from Tree

Inherited from TreeContextApiImpl

Inherited from TreeContextApi

Inherited from TreeApi

Inherited from TreeBase

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from LabelDef to StringAdd

Inherited by implicit conversion any2stringfmt from LabelDef to StringFormat

Inherited by implicit conversion any2ArrowAssoc from LabelDef to ArrowAssoc[LabelDef]

Inherited by implicit conversion any2Ensuring from LabelDef to Ensuring[LabelDef]