scala.collection.generic

GenericTraversableTemplate

trait GenericTraversableTemplate[+A, +CC[X] <: GenTraversable[X]] 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.

Source
GenericTraversableTemplate.scala
Since

2.8

Linear Supertypes
HasNewBuilder[A, CC[A] @scala.annotation.unchecked.uncheckedVariance], AnyRef, Any
Known Subclasses
::, Appended, Appended, Appended, Appended, Appended, Appended, Appended, Appended, Appended, ArrayBuffer, ArraySeq, ArrayStack, Atom, Attribute, BitSet, BitSet, BitSet, BitSet1, BitSet2, BitSetN, Buffer, BufferProxy, BufferWrapper, Comment, ConcurrentMap, Cons, Content, DefaultKeySet, DefaultKeySet, DefaultKeySet, DefaultKeySortedSet, DefaultKeySortedSet, DefaultMap, DefaultMap, DefaultMapModel, DefaultValuesIterable, DefaultValuesIterable, Document, DoubleLinkedList, DroppedWhile, DroppedWhile, DroppedWhile, DroppedWhile, DroppedWhile, DroppedWhile, DroppedWhile, DroppedWhile, Elem, Empty, EmptyView, EmptyView, EmptyView, EmptyView, EmptyView, EmptyView, EmptyView, EntityRef, Exclusive, Filtered, Filtered, Filtered, Filtered, Filtered, Filtered, Filtered, Filtered, FilteredKeys, FilteredKeys, FlatMapped, FlatMapped, FlatMapped, FlatMapped, FlatMapped, FlatMapped, FlatMapped, Forced, Forced, Forced, Forced, Forced, Forced, Forced, Forced, Forced, GenIterable, GenIterableView, GenIterableViewLike, GenMap, GenSeq, GenSeqView, GenSeqViewLike, GenSet, GenTraversable, GenTraversableView, GenTraversableViewLike, GenericParMapTemplate, GenericParTemplate, GenericSetTemplate, Group, HashMap, HashMap, HashMap1, HashSet, HashSet, HashSet1, HashTrieMap, HashTrieSet, History, ImmutableDefaultKeySet, ImmutableMapAdaptor, ImmutableSetAdaptor, Impl, Inclusive, Inclusive, IndexedSeq, IndexedSeq, IndexedSeq, IndexedSeqView, Indices, IntMap, Iterable, Iterable, Iterable, IterableForwarder, IterableProxy, IterableView, IterableViewLike, LinearSeq, LinearSeq, LinearSeq, LinkedHashMap, LinkedHashSet, LinkedList, List, ListBuffer, ListMap, ListMap, ListSet, LongMap, Map, Map, Map, Map, Map1, Map2, Map3, Map4, MapProxy, MapProxy, MapProxy, Mapped, Mapped, Mapped, Mapped, Mapped, Mapped, Mapped, Mapped, Mapped, MappedValues, MappedValues, MemberScope, MemberScopeApi, MetaData, MultiMap, MutableList, Nil, Node, Node, Node, NodeBuffer, NodeSeq, Null, NumericRange, ObservableBuffer, ObservableMap, ObservableSet, OpenHashMap, PCData, PagedSeq, ParArray, ParHashMap, ParHashMap, ParHashSet, ParHashSet, ParIterable, ParIterable, ParIterable, ParIterableView, ParIterableViewLike, ParMap, ParMap, ParMap, ParRange, ParSeq, ParSeq, ParSeq, ParSeqView, ParSeqViewLike, ParSet, ParSet, ParSet, ParTrieMap, ParVector, Patched, Patched, Patched, Patched, PicklerEnv, PrefixedAttribute, Prepended, Prepended, Prepended, Prepended, PriorityQueue, PriorityQueueProxy, ProcInstr, Queue, Queue, QueueProxy, Range, RefBuffer, ResizableArray, Reversed, Reversed, Reversed, Reversed, Reversed, RevertibleHistory, Scope, Scope, ScopeApi, Script, SelectionSet, Seq, Seq, Seq, SeqForwarder, SeqProxy, SeqView, SeqViewLike, Set, Set, Set, Set1, Set2, Set3, Set4, SetProxy, SetProxy, SetProxy, Sliced, Sliced, Sliced, Sliced, Sliced, Sliced, Sliced, Sliced, Sliced, Sliced, SortedMap, SortedMap, SortedSet, SortedSet, SortedSet, SpecialNode, Stack, Stack, StackProxy, Stream, StreamView, StreamViewLike, StringBuilder, SynchronizedBuffer, SynchronizedMap, SynchronizedPriorityQueue, SynchronizedQueue, SynchronizedSet, SynchronizedStack, SystemProperties, TakenWhile, TakenWhile, TakenWhile, TakenWhile, TakenWhile, TakenWhile, TakenWhile, TakenWhile, Text, Transformed, Transformed, Transformed, Transformed, Transformed, Transformed, Transformed, Transformed, Transformed, Transformed, Traversable, Traversable, Traversable, TraversableForwarder, TraversableProxy, TraversableView, TraversableViewLike, TreeMap, TreeSet, TreeSet, TrieMap, UnPicklerEnv, Unparsed, UnprefixedAttribute, UnrolledBuffer, ValueSet, Vector, WeakHashMap, WithDefault, WithDefault, WithDefault, WithDefault, WithDefault, WithDefault, WrappedArray, WrappedString, Zipped, Zipped, Zipped, Zipped, Zipped, Zipped, Zipped, ZippedAll, ZippedAll, ZippedAll, ZippedAll, ZippedAll, ZippedAll, ZippedAll, columns, indices, items, ofBoolean, ofByte, ofChar, ofDouble, ofFloat, ofInt, ofLong, ofRef, ofShort, ofUnit, pages, rows
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. GenericTraversableTemplate
  2. HasNewBuilder
  3. AnyRef
  4. 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

Abstract Value Members

  1. abstract def companion: GenericCompanion[CC]

    The factory companion object that builds instances of class CC.

    The factory companion object that builds instances of class CC. (or its Iterable superclass where class CC is not a Seq.)

  2. abstract def head: A

    Selects the first element of this collection.

    Selects the first element of this collection.

    returns

    the first element of this collection.

    Exceptions thrown
    `NoSuchElementException`

    if the collection is empty.

  3. abstract def isEmpty: Boolean

    Tests whether this collection is empty.

    Tests whether this collection is empty.

    returns

    true if the collection contain no elements, false otherwise.

Concrete 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 GenericTraversableTemplate[A, CC] to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (GenericTraversableTemplate[A, CC], B)

    Implicit information
    This member is added by an implicit conversion from GenericTraversableTemplate[A, CC] to ArrowAssoc[GenericTraversableTemplate[A, CC]] 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. 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.

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

    not specified by SLS as a member of AnyRef

  10. def ensuring(cond: (GenericTraversableTemplate[A, CC]) ⇒ Boolean, msg: ⇒ Any): GenericTraversableTemplate[A, CC]

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

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

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

    Implicit information
    This member is added by an implicit conversion from GenericTraversableTemplate[A, CC] to Ensuring[GenericTraversableTemplate[A, CC]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. 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
  15. def equals(arg0: Any): Boolean

    The equality method for reference types.

    The equality method for reference types. Default implementation delegates to eq.

    See also equals in scala.Any.

    returns

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

    Definition Classes
    AnyRef → Any
  16. 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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
    Note

    not specified by SLS as a member of AnyRef

  17. def flatten[B]: CC[B]

    [use case] Converts this collection of traversable collections into a collection formed by the elements of these traversable collections.

    [use case]

    Converts this collection of traversable collections into a collection formed by the elements of these traversable collections.

    The resulting collection's type will be guided by the static type of collection. For example:

    val xs = List(Set(1, 2, 3), Set(1, 2, 3))
    // xs == List(1, 2, 3, 1, 2, 3)
    
    val ys = Set(List(1, 2, 3), List(3, 2, 1))
    // ys == Set(1, 2, 3)
    B

    the type of the elements of each traversable collection.

    returns

    a new collection resulting from concatenating all element collections.

    Full Signature

    def flatten[B](implicit asTraversable: (A) ⇒ GenTraversableOnce[B]): CC[B]

  18. abstract def foreach(f: (A) ⇒ Unit): Unit

    [use case]

    [use case]
    f

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

    Full Signature

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

  19. 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 GenericTraversableTemplate[A, CC] to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  20. def genericBuilder[B]: Builder[B, CC[B]]

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

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

  22. def hashCode(): Int

    The hashCode method for reference types.

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

    returns

    the hash code value for this object.

    Definition Classes
    AnyRef → Any
  23. 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
  24. 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
  25. def newBuilder: Builder[A, CC[A]]

    The builder that builds instances of type CC[A]

    The builder that builds instances of type CC[A]

    Attributes
    protected[this]
    Definition Classes
    GenericTraversableTemplateHasNewBuilder
  26. 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

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

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

    Definition Classes
    AnyRef
  29. def toString(): String

    Creates a String representation of this object.

    Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.

    returns

    a String representation of the object.

    Definition Classes
    AnyRef → Any
  30. def transpose[B](implicit asTraversable: (A) ⇒ GenTraversableOnce[B]): CC[CC[B]]

    Transposes this collection of traversable collections into a collection of collections.

    Transposes this collection of traversable collections into a collection of collections.

    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 two-dimensional collection of collections which has as nth row the nth column of this collection.

    Annotations
    @migration
    Migration

    (Changed in version 2.9.0) transpose throws an IllegalArgumentException if collections are not uniformly sized.

    Exceptions thrown
    `IllegalArgumentException`

    if all collections in this collection are not of the same size.

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

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

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

    A1

    the type of the first half of the element pairs

    A2

    the type of the second half of the element pairs

    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.

  32. def unzip3[A1, A2, A3](implicit asTriple: (A) ⇒ (A1, A2, A3)): (CC[A1], CC[A2], CC[A3])

    Converts this collection of triples into three collections of the first, second, and third element of each triple.

    Converts this collection of triples into three collections of the first, second, and third element of each triple.

    A1

    the type of the first member of the element triples

    A2

    the type of the second member of the element triples

    A3

    the type of the third member of the element triples

    asTriple

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

    returns

    a triple collections, containing the first, second, respectively third member of each element triple of this collection.

  33. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. def [B](y: B): (GenericTraversableTemplate[A, CC], B)

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

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from GenericTraversableTemplate[A, CC] to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (genericTraversableTemplate: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from GenericTraversableTemplate[A, CC] to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (genericTraversableTemplate: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: GenericTraversableTemplate[A, CC]

    Implicit information
    This member is added by an implicit conversion from GenericTraversableTemplate[A, CC] to ArrowAssoc[GenericTraversableTemplate[A, CC]] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (genericTraversableTemplate: ArrowAssoc[GenericTraversableTemplate[A, CC]]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: GenericTraversableTemplate[A, CC]

    Implicit information
    This member is added by an implicit conversion from GenericTraversableTemplate[A, CC] to Ensuring[GenericTraversableTemplate[A, CC]] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (genericTraversableTemplate: Ensuring[GenericTraversableTemplate[A, CC]]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from HasNewBuilder[A, CC[A] @scala.annotation.unchecked.uncheckedVariance]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from GenericTraversableTemplate[A, CC] to StringAdd

Inherited by implicit conversion any2stringfmt from GenericTraversableTemplate[A, CC] to StringFormat

Inherited by implicit conversion any2ArrowAssoc from GenericTraversableTemplate[A, CC] to ArrowAssoc[GenericTraversableTemplate[A, CC]]

Inherited by implicit conversion any2Ensuring from GenericTraversableTemplate[A, CC] to Ensuring[GenericTraversableTemplate[A, CC]]

Ungrouped