scala.collection.generic

GenericTraversableTemplate

trait GenericTraversableTemplate[+A, +CC] extends HasNewBuilder[A, CC[A]]

A template class for companion objects of regular collection classes that represent an unconstrained higher-kinded type.

A

The type of the collection elements.

CC

The type constructor representing the collection class.

known subclasses: GenericSetTemplate, Iterable, Seq, Traversable, Traversable, Iterable, Seq, Traversable, Iterable, Seq, LinearSeq, LinearSeq, IndexedSeq, IndexedSeq, Buffer, ArrayBuffer, ResizableArray, GenericArray, LinkedList, DoubleLinkedList, ListBuffer, LinearSeq, List, IndexedSeq, Stream, Vector, Stack

Inherits

  1. HasNewBuilder
  2. AnyRef
  3. Any

Value Members

  1. def companion: GenericCompanion[CC[X][X]]

    The factory companion object that builds instances of class CC

    The factory companion object that builds instances of class CC.

    attributes: abstract
  2. def equals(arg0: Any): Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is 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 AnyRef 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 often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

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

    definition classes: AnyRef ⇐ Any
  3. def flatten[B]: CC[B]

    [use case] Converts this collection of traversable collections into a collection in which all element collections are concatenated

    [use case]

    Converts this collection of traversable collections into a collection in which all element collections are concatenated.

    B

    the type of the elements of each traversable collection.

    returns

    a new collection resulting from concatenating all element collections.

    attributes: abstract
  4. def flatten[B](asTraversable: (A) ⇒ Traversable[B]): CC[B]

    Converts this collection of traversable collections into a collection in which all element collections are concatenated

    Converts this collection of traversable collections into a collection in which all element collections are concatenated.

    B

    the type of the elements of each traversable collection.

    asTraversable

    an implicit conversion which asserts that the element type of this collection is a Traversable.

    returns

    a new collection resulting from concatenating all element collections.

  5. def foreach(f: (A) ⇒ Unit): Unit

    [use case] Applies a function f to all elements of this collection

    [use case]

    Applies a function f to all elements of this collection.

    f

    the function that is applied for its side-effect to every element. The result of function f is discarded.

    attributes: abstract
  6. def foreach[U](f: (A) ⇒ U): Unit

    Applies a function f to all elements of this collection

    Applies a function f to all elements of this collection.

    U

    the type parameter describing the result of function f. This result will always be ignored. Typically U is Unit, but this is not necessary.

    f

    the function that is applied for its side-effect to every element. The result of function f is discarded.

    attributes: abstract
  7. def genericBuilder[B]: Builder[B, CC[B]]

    The generic builder that builds instances of CC at arbitrary element types

    The generic builder that builds instances of CC at arbitrary element types.

  8. def hashCode(): Int

    Returns a hash code value for the object

    Returns 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.

    definition classes: AnyRef ⇐ Any
  9. def head: A

    Selects the first element of this collection

    Selects the first element of this collection.

    attributes: abstract
  10. def isEmpty: Boolean

    Tests whether this collection is empty

    Tests whether this collection is empty.

    attributes: abstract
  11. def toString(): String

    Returns a string representation of the object

    Returns a string representation of the object.

    The default representation is platform dependent.

    definition classes: AnyRef ⇐ Any
  12. def transpose[B](asTraversable: (A) ⇒ Traversable[B]): CC[CC[B]]

    Transposes this collection of traversable collections into

    Transposes this collection of traversable collections into

  13. def unzip[A1, A2](asPair: (A) ⇒ (A1, A2)): (CC[A1], CC[A2])

    Converts this collection of pairs into two collections of the first and second halfs of each pair

    Converts this collection of pairs into two collections of the first and second halfs of each pair.

    asPair

    an implicit conversion which asserts that the element type of this collection is a pair.

    returns

    a pair collections, containing the first, respectively second half of each element pair of this collection.