blob: 1dbf46b4c2eb6a9cffc148cff26ccc2d173bc2ea (
plain) (
tree)
|
|
/* __ *\
** ________ ___ / / ___ Scala API **
** / __/ __// _ | / / / _ | (c) 2002-2011, LAMP/EPFL **
** __\ \/ /__/ __ |/ /__/ __ | http://scala-lang.org/ **
** /____/\___/_/ |_/____/_/ | | **
** |/ **
\* */
package scala
/** Base trait for all products, which in the standard library include at least
* [[scala.Product1]] through [[scala.Product22]] and therefore also their
* subclasses [[scala.Tuple1]] through [[scala.Tuple22]]. In addition, all case
* classes implement Product with synthetically generated methods.
*
* @author Burak Emir
* @version 1.0
* @since 2.3
*/
trait Product extends Equals {
/** The nth element of this product, 0-based. In other words, for a
* product `A(x_1, ..., x_k)`, returns x_(n+1) where 0 < n < k.
*
* @param n the index of the element to return
* @throws IndexOutOfBoundsException
* @return the element `n` elements after the first element
*/
def productElement(n: Int): Any
/** The size of this product.
* @return for a product `A(x_1, ..., x_k)`, returns `k`
*/
def productArity: Int
/** An iterator over all the elements of this product.
* @return in the default implementation, an Iterator[Any]
*/
def productIterator: Iterator[Any] = new Iterator[Any] {
private var c: Int = 0
private val cmax = productArity
def hasNext = c < cmax
def next() = { val result = productElement(c); c += 1; result }
}
@deprecated("use productIterator instead", "2.8.0")
def productElements: Iterator[Any] = productIterator
/** 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.
*
* @return in the default implementation, the empty string
*/
def productPrefix = ""
}
|