org.apache.spark.util

Class CollectionAccumulator<T>

Object

org.apache.spark.util.AccumulatorV2<T,java.util.List<T>>

org.apache.spark.util.CollectionAccumulator<T>

All Implemented Interfaces:

java.io.Serializable

public class CollectionAccumulator<T>
extends AccumulatorV2<T,java.util.List<T>>

An accumulator for collecting a list of elements.

Since:

2.0.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CollectionAccumulator()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(T v) Takes the inputs and accumulates.
CollectionAccumulator<T>	copy() Creates a new copy of this accumulator.
CollectionAccumulator<T>	copyAndReset() Creates a new copy of this accumulator, which is zero value.
boolean	isZero() Returns if this accumulator is zero value or not.
void	merge(AccumulatorV2<T,java.util.List<T>> other) Merges another same-type accumulator into this one and update its state, i.e.
void	reset() Resets this accumulator, which is zero value.
java.util.List<T>	value() Defines the current value of this accumulator

Methods inherited from class org.apache.spark.util.AccumulatorV2

id, isRegistered, name, toString

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CollectionAccumulator

public CollectionAccumulator()

Method Detail

isZero

public boolean isZero()

Description copied from class: AccumulatorV2

Returns if this accumulator is zero value or not. e.g. for a counter accumulator, 0 is zero value; for a list accumulator, Nil is zero value.

Specified by:

isZero in class AccumulatorV2<T,java.util.List<T>>

Returns:

(undocumented)

copyAndReset

public CollectionAccumulator<T> copyAndReset()

Description copied from class: AccumulatorV2

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

Overrides:

copyAndReset in class AccumulatorV2<T,java.util.List<T>>

Returns:

(undocumented)

copy

public CollectionAccumulator<T> copy()

Description copied from class: AccumulatorV2

Creates a new copy of this accumulator.

Specified by:

copy in class AccumulatorV2<T,java.util.List<T>>

Returns:

(undocumented)

reset

public void reset()

Description copied from class: AccumulatorV2

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

Specified by:

reset in class AccumulatorV2<T,java.util.List<T>>

add

public void add(T v)

Description copied from class: AccumulatorV2

Takes the inputs and accumulates.

Specified by:

add in class AccumulatorV2<T,java.util.List<T>>

Parameters:

v - (undocumented)

merge

public void merge(AccumulatorV2<T,java.util.List<T>> other)

Description copied from class: AccumulatorV2

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

Specified by:

merge in class AccumulatorV2<T,java.util.List<T>>

Parameters:

other - (undocumented)

value

public java.util.List<T> value()

Description copied from class: AccumulatorV2

Defines the current value of this accumulator

Specified by:

value in class AccumulatorV2<T,java.util.List<T>>

Returns:

(undocumented)