Packages

c

org.apache.spark.util

CollectionAccumulator

class CollectionAccumulator[T] extends AccumulatorV2[T, List[T]]

An accumulator for collecting a list of elements.

Source
AccumulatorV2.scala
Since

2.0.0

Linear Supertypes
AccumulatorV2[T, List[T]], Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CollectionAccumulator
  2. AccumulatorV2
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new CollectionAccumulator()

Value Members

  1. def add(v: T): Unit

    Takes the inputs and accumulates.

    Takes the inputs and accumulates.

    Definition Classes
    CollectionAccumulator → AccumulatorV2
  2. def copy(): CollectionAccumulator[T]

    Creates a new copy of this accumulator.

    Creates a new copy of this accumulator.

    Definition Classes
    CollectionAccumulator → AccumulatorV2
  3. def copyAndReset(): CollectionAccumulator[T]

    Creates a new copy of this accumulator, which is zero value.

    Creates a new copy of this accumulator, which is zero value. i.e. call isZero on the copy must return true.

    Definition Classes
    CollectionAccumulator → AccumulatorV2
  4. final def id: Long

    Returns the id of this accumulator, can only be called after registration.

    Returns the id of this accumulator, can only be called after registration.

    Definition Classes
    AccumulatorV2
  5. final def isRegistered: Boolean

    Returns true if this accumulator has been registered.

    Returns true if this accumulator has been registered.

    Definition Classes
    AccumulatorV2
    Note

    All accumulators must be registered before use, or it will throw exception.

  6. def isZero: Boolean

    Returns false if this accumulator instance has any values in it.

    Returns false if this accumulator instance has any values in it.

    Definition Classes
    CollectionAccumulator → AccumulatorV2
  7. def merge(other: AccumulatorV2[T, List[T]]): Unit

    Merges another same-type accumulator into this one and update its state, i.e.

    Merges another same-type accumulator into this one and update its state, i.e. this should be merge-in-place.

    Definition Classes
    CollectionAccumulator → AccumulatorV2
  8. final def name: Option[String]

    Returns the name of this accumulator, can only be called after registration.

    Returns the name of this accumulator, can only be called after registration.

    Definition Classes
    AccumulatorV2
  9. def reset(): Unit

    Resets this accumulator, which is zero value.

    Resets this accumulator, which is zero value. i.e. call isZero must return true.

    Definition Classes
    CollectionAccumulator → AccumulatorV2
  10. def toString(): String
    Definition Classes
    AccumulatorV2 → AnyRef → Any
  11. def value: List[T]

    Defines the current value of this accumulator

    Defines the current value of this accumulator

    Definition Classes
    CollectionAccumulator → AccumulatorV2