Package org.apache.flink.api.common.accumulators

Class IntCounter

java.lang.Object

org.apache.flink.api.common.accumulators.IntCounter

All Implemented Interfaces:

Serializable, Cloneable, Accumulator<Integer,Integer>, SimpleAccumulator<Integer>

@PublicEvolving
public class IntCounter
extends Object
implements SimpleAccumulator<Integer>

An accumulator that sums up Integer values.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
IntCounter()
IntCounter(int value)

Method Summary

Modifier and Type	Method	Description
void	add(int value)
void	add(Integer value)	Consider using add(int) instead for primitive int values
IntCounter	clone()	Duplicates the accumulator.
Integer	getLocalValue()
int	getLocalValuePrimitive()
void	merge(Accumulator<Integer,Integer> other)	Used by system internally to merge the collected parts of an accumulator at the end of the job.
void	resetLocal()	Reset the local value.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

IntCounter

public IntCounter()

IntCounter

public IntCounter(int value)

Method Detail

add

public void add(Integer value)

Consider using add(int) instead for primitive int values

Specified by:

add in interface Accumulator<Integer,Integer>

Parameters:

value - The value to add to the accumulator object

getLocalValue

public Integer getLocalValue()

Specified by:

getLocalValue in interface Accumulator<Integer,Integer>

Returns:

local The local value from the current UDF context

merge

public void merge(Accumulator<Integer,Integer> other)

Description copied from interface: Accumulator

Used by system internally to merge the collected parts of an accumulator at the end of the job.

Specified by:

merge in interface Accumulator<Integer,Integer>

Parameters:

other - Reference to accumulator to merge in.

resetLocal

public void resetLocal()

Description copied from interface: Accumulator

Reset the local value. This only affects the current UDF context.

Specified by:

resetLocal in interface Accumulator<Integer,Integer>

clone

public IntCounter clone()

Description copied from interface: Accumulator

Duplicates the accumulator. All subclasses need to properly implement cloning and cannot throw a CloneNotSupportedException

Specified by:

clone in interface Accumulator<Integer,Integer>

Overrides:

clone in class Object

Returns:

The duplicated accumulator.

add

public void add(int value)

getLocalValuePrimitive

public int getLocalValuePrimitive()

toString

public String toString()

Overrides:

toString in class Object