scala.tools.nsc.transform.patmat.MatchTreeMaking.TreeMakers

# ProductExtractorTreeMaker

#### case class ProductExtractorTreeMaker(prevBinder: Global.Symbol, extraCond: Option[Global.Tree])(subPatBinders: List[Global.Symbol], subPatRefs: List[Global.Tree], mutableBinders: List[Global.Symbol], binderKnownNonNull: Boolean, ignoredSubPatBinders: Set[Global.Symbol]) extends FunTreeMaker with PreserveSubPatBinders with Product with Serializable

An optimized version of ExtractorTreeMaker for Products. For now, this is hard-coded to case classes, and we simply extract the case class fields.

The values for the subpatterns, as specified by the case class fields at the time of extraction, are stored in local variables that re-use the symbols in `subPatBinders`. This makes extractor patterns more debuggable (SI-5739) as well as avoiding mutation after the pattern has been matched (SI-5158, SI-6070)

TODO: make this user-definable as follows When a companion object defines a method `def unapply_1(x: T): U_1`, but no `def unapply` or `def unapplySeq`, the extractor is considered to match any non-null value of type T the pattern is expected to have as many sub-patterns as there are `def unapply_I(x: T): U_I` methods, and the type of the I'th sub-pattern is `U_I`. The same exception for Seq patterns applies: if the last extractor is of type `Seq[U_N]`, the pattern must have at least N arguments (exactly N if the last argument is annotated with `: _*`). The arguments starting at N (and beyond) are taken from the sequence returned by apply_N, and it is checked that that sequence has enough elements to provide values for all expected sub-patterns.

For a case class C, the implementation is assumed to be `def unapply_I(x: C) = x._I`, and the extractor call is inlined under that assumption.

Linear Supertypes
Serializable, java.io.Serializable, Product, Equals, PreserveSubPatBinders, FunTreeMaker, TreeMaker, AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering

1. Alphabetic
2. By inheritance

Inherited

1. ProductExtractorTreeMaker
2. Serializable
3. Serializable
4. Product
5. Equals
6. PreserveSubPatBinders
7. FunTreeMaker
8. TreeMaker
9. AnyRef
10. Any

Implicitly

1. by any2stringadd
2. by StringFormat
3. by Ensuring
4. by ArrowAssoc

1. Hide All
2. Show all

Learn more about member selection
Visibility

1. Public
2. All

### Instance Constructors

1. #### new ProductExtractorTreeMaker(prevBinder: Global.Symbol, extraCond: Option[Global.Tree])(subPatBinders: List[Global.Symbol], subPatRefs: List[Global.Tree], mutableBinders: List[Global.Symbol], binderKnownNonNull: Boolean, ignoredSubPatBinders: Set[Global.Symbol])

### 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 information
     This member is added by an implicit conversion from ProductExtractorTreeMaker to any2stringadd[ProductExtractorTreeMaker] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd

4. #### def ->[B](y: B): (ProductExtractorTreeMaker, B)

   Implicit information
     This member is added by an implicit conversion from ProductExtractorTreeMaker to ArrowAssoc[ProductExtractorTreeMaker] 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 bindSubPats(in: Global.Tree): Global.Tree

   Definition Classes
     PreserveSubPatBinders

8. #### def chainBefore(next: Global.Tree)(casegen: TreeMakers.Casegen): Global.Tree

   Definition Classes
     ProductExtractorTreeMaker → TreeMaker

9. #### def clone(): AnyRef

   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @throws( ... )

10. #### def emitVars: Boolean

    Definition Classes
      PreserveSubPatBinders

11. #### def ensuring(cond: (ProductExtractorTreeMaker) ⇒ Boolean, msg: ⇒ Any): ProductExtractorTreeMaker

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

12. #### def ensuring(cond: (ProductExtractorTreeMaker) ⇒ Boolean): ProductExtractorTreeMaker

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

13. #### def ensuring(cond: Boolean, msg: ⇒ Any): ProductExtractorTreeMaker

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

14. #### def ensuring(cond: Boolean): ProductExtractorTreeMaker

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

15. #### final def eq(arg0: AnyRef): Boolean

    Definition Classes
      AnyRef

16. #### val extraCond: Option[Global.Tree]

17. #### def extraStoredBinders: Set[Global.Symbol]

    Definition Classes
      ProductExtractorTreeMaker → PreserveSubPatBinders

18. #### def finalize(): Unit

    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )

19. #### def formatted(fmtstr: String): String

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

20. #### final def getClass(): Class[_]

    Definition Classes
      AnyRef → Any

21. #### val ignoredSubPatBinders: Set[Global.Symbol]

    Definition Classes
      ProductExtractorTreeMaker → PreserveSubPatBinders

22. #### final def isInstanceOf[T0]: Boolean

    Definition Classes
      Any

23. #### lazy val localSubstitution: TreeMakers.Substitution

    Attributes
      protected
    Definition Classes
      PreserveSubPatBinders → TreeMaker

24. #### val mutableBinders: List[Global.Symbol]

25. #### final def ne(arg0: AnyRef): Boolean

    Definition Classes
      AnyRef

26. #### val nextBinder: Global.Symbol

    Definition Classes
      ProductExtractorTreeMaker → FunTreeMaker

27. #### final def notify(): Unit

    Definition Classes
      AnyRef

28. #### final def notifyAll(): Unit

    Definition Classes
      AnyRef

29. #### def pos: Global.Position

    Definition Classes
      FunTreeMaker → TreeMaker

30. #### val prevBinder: Global.Symbol

31. #### lazy val storedBinders: Set[Global.Symbol]

    Definition Classes
      PreserveSubPatBinders

32. #### val subPatBinders: List[Global.Symbol]

    Definition Classes
      ProductExtractorTreeMaker → PreserveSubPatBinders

33. #### val subPatRefs: List[Global.Tree]

    Definition Classes
      ProductExtractorTreeMaker → PreserveSubPatBinders

34. #### def subPatternsAsSubstitution: TreeMakers.Substitution

    The substitution that specifies the trees that compute the values of the subpattern binders.

    The substitution that specifies the trees that compute the values of the subpattern binders.

    We pretend to replace the subpattern binders by subpattern refs (Even though we don't do so anymore -- see SI-5158, SI-5739 and SI-6070.)

    Definition Classes
      PreserveSubPatBinders → TreeMaker

35. #### def substitution: TreeMakers.Substitution

    captures the scope and the value of the bindings in patterns important *when* the substitution happens (can't accumulate and do at once after the full matcher has been constructed)

    captures the scope and the value of the bindings in patterns important *when* the substitution happens (can't accumulate and do at once after the full matcher has been constructed)

    Definition Classes
      TreeMaker

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

    Definition Classes
      AnyRef

37. #### def toString(): String

    Definition Classes
      ProductExtractorTreeMaker → AnyRef → Any

38. #### final def wait(): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

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

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

40. #### final def wait(arg0: Long): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

41. #### def →[B](y: B): (ProductExtractorTreeMaker, B)

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

### Inherited from Serializable

### Inherited from java.io.Serializable

### Inherited from Product

### Inherited from Equals

### Inherited from PreserveSubPatBinders

### Inherited from FunTreeMaker

### Inherited from TreeMaker

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd from ProductExtractorTreeMaker to any2stringadd[ProductExtractorTreeMaker]

### Inherited by implicit conversion StringFormat from ProductExtractorTreeMaker to StringFormat[ProductExtractorTreeMaker]

### Inherited by implicit conversion Ensuring from ProductExtractorTreeMaker to Ensuring[ProductExtractorTreeMaker]

### Inherited by implicit conversion ArrowAssoc from ProductExtractorTreeMaker to ArrowAssoc[ProductExtractorTreeMaker]

### Ungrouped