W3cubDocs

/Scala 2.12 Library

Trait scala.Product10

Companion object Product10

trait Product10[+T1, +T2, +T3, +T4, +T5, +T6, +T7, +T8, +T9, +T10] extends Product

Product10 is a Cartesian product of 10 components.

Source
Product10.scala
Since

2.3

Linear Supertypes
Known Subclasses

Abstract Value Members

abstract def _1: T1

A projection of element 1 of this Product.

returns

A projection of element 1.

abstract def _10: T10

A projection of element 10 of this Product.

returns

A projection of element 10.

abstract def _2: T2

A projection of element 2 of this Product.

returns

A projection of element 2.

abstract def _3: T3

A projection of element 3 of this Product.

returns

A projection of element 3.

abstract def _4: T4

A projection of element 4 of this Product.

returns

A projection of element 4.

abstract def _5: T5

A projection of element 5 of this Product.

returns

A projection of element 5.

abstract def _6: T6

A projection of element 6 of this Product.

returns

A projection of element 6.

abstract def _7: T7

A projection of element 7 of this Product.

returns

A projection of element 7.

abstract def _8: T8

A projection of element 8 of this Product.

returns

A projection of element 8.

abstract def _9: T9

A projection of element 9 of this Product.

returns

A projection of element 9.

abstract def canEqual(that: Any): Boolean

A method that should be called from every well-designed equals method that is open to be overridden in a subclass. See Programming in Scala, Chapter 28 for discussion and design.

that

the value being probed for possible equality

returns

true if this instance can possibly equal that, otherwise false

Definition Classes
Equals

abstract def getClass(): Class[_]

Returns the runtime class representation of the object.

returns

a class object corresponding to the runtime type of the receiver.

Definition Classes
Any

Concrete Value Members

final def !=(arg0: Any): Boolean

Test two objects for inequality.

returns

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

Definition Classes
Any

final def ##(): Int

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
Any

def +(other: String): String

Implicit
This member is added by an implicit conversion from Product10[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10] to any2stringadd[Product10[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10]] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd

def ->[B](y: B): (Product10[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10], B)

Implicit
This member is added by an implicit conversion from Product10[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10] to ArrowAssoc[Product10[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()

final def ==(arg0: Any): Boolean

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

final def asInstanceOf[T0]: 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.

def ensuring(cond: (Product10[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10]) ⇒ Boolean, msg: ⇒ Any): Product10[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10]

Implicit
This member is added by an implicit conversion from Product10[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10] to Ensuring[Product10[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring

def ensuring(cond: (Product10[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10]) ⇒ Boolean): Product10[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10]

Implicit
This member is added by an implicit conversion from Product10[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10] to Ensuring[Product10[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring

def ensuring(cond: Boolean, msg: ⇒ Any): Product10[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10]

Implicit
This member is added by an implicit conversion from Product10[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10] to Ensuring[Product10[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring

def ensuring(cond: Boolean): Product10[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10]

Implicit
This member is added by an implicit conversion from Product10[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10] to Ensuring[Product10[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring

def equals(arg0: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an 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 Any 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 usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

returns

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

Definition Classes
Any

def formatted(fmtstr: String): String

Returns string formatted according to given format string. Format strings are as for String.format (@see java.lang.String.format).

Implicit
This member is added by an implicit conversion from Product10[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10] to StringFormat[Product10[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10]] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()

def hashCode(): Int

Calculate 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 this object.

Definition Classes
Any

final def isInstanceOf[T0]: Boolean

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

def productArity: Int

The arity of this product.

returns

10

Definition Classes
Product10Product

def productElement(n: Int): Any

Returns the n-th projection of this product if 0 <= n < productArity, otherwise throws an IndexOutOfBoundsException.

n

number of the projection to be returned

returns

same as ._(n+1), for example productElement(0) is the same as ._1.

Definition Classes
Product10Product
Annotations
@throws( clazz = classOf[IndexOutOfBoundsException] )
Exceptions thrown

def productIterator: Iterator[Any]

An iterator over all the elements of this product.

returns

in the default implementation, an Iterator[Any]

Definition Classes
Product

def productPrefix: String

A string used in the toString methods of derived classes. Implementations may override this method to prepend a string prefix to the result of toString methods.

returns

in the default implementation, the empty string

Definition Classes
Product

def toString(): String

Returns a string representation of the object.

The default representation is platform dependent.

returns

a string representation of the object.

Definition Classes
Any

def [B](y: B): (Product10[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10], B)

Implicit
This member is added by an implicit conversion from Product10[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10] to ArrowAssoc[Product10[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

© 2002-2019 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://www.scala-lang.org/api/2.12.9/scala/Product10.html