org.apache.hadoop.mapreduce.counters

Interface CounterGroupBase<T extends Counter>

Type Parameters:

T - type of the counter for the group

All Superinterfaces:

java.lang.Iterable<T>, org.apache.hadoop.io.Writable

All Known Subinterfaces:

CounterGroup

All Known Implementing Classes:

AbstractCounterGroup, Counters.Group, FileSystemCounterGroup, FrameworkCounterGroup

@InterfaceAudience.Public
@InterfaceStability.Evolving
public interface CounterGroupBase<T extends Counter>
extends org.apache.hadoop.io.Writable, java.lang.Iterable<T>

The common counter group interface.

Method Summary

Methods

Modifier and Type	Method and Description
T	addCounter(java.lang.String name, java.lang.String displayName, long value) Add a counter to this group
void	addCounter(T counter) Add a counter to this group.
T	findCounter(java.lang.String counterName) Find a counter in the group.
T	findCounter(java.lang.String counterName, boolean create) Find a counter in the group
T	findCounter(java.lang.String counterName, java.lang.String displayName) Find a counter in the group.
java.lang.String	getDisplayName() Get the display name of the group.
java.lang.String	getName() Get the internal name of the group
CounterGroupBase<T>	getUnderlyingGroup() Exposes the underlying group type if a facade.
void	incrAllCounters(CounterGroupBase<T> rightGroup) Increment all counters by a group of counters
void	setDisplayName(java.lang.String displayName) Set the display name of the group
int	size()

Methods inherited from interface org.apache.hadoop.io.Writable

readFields, write

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

getName

java.lang.String getName()

Get the internal name of the group

Returns:

the internal name

getDisplayName

java.lang.String getDisplayName()

Get the display name of the group.

Returns:

the human readable name

setDisplayName

void setDisplayName(java.lang.String displayName)

Set the display name of the group

Parameters:

displayName - of the group

addCounter

void addCounter(T counter)

Add a counter to this group.

Parameters:

counter - to add

addCounter

T addCounter(java.lang.String name,
           java.lang.String displayName,
           long value)

Add a counter to this group

Parameters:

name - of the counter

displayName - of the counter

value - of the counter

Returns:

the counter

findCounter

T findCounter(java.lang.String counterName,
            java.lang.String displayName)

Find a counter in the group.

Parameters:

counterName - the name of the counter

displayName - the display name of the counter

Returns:

the counter that was found or added

findCounter

T findCounter(java.lang.String counterName,
            boolean create)

Find a counter in the group

Parameters:

counterName - the name of the counter

create - create the counter if not found if true

Returns:

the counter that was found or added or null if create is false

findCounter

T findCounter(java.lang.String counterName)

Find a counter in the group.

Parameters:

counterName - the name of the counter

Returns:

the counter that was found or added

size

int size()

Returns:

the number of counters in this group.

incrAllCounters

void incrAllCounters(CounterGroupBase<T> rightGroup)

Increment all counters by a group of counters

Parameters:

rightGroup - the group to be added to this group

getUnderlyingGroup

CounterGroupBase<T> getUnderlyingGroup()

Exposes the underlying group type if a facade.

Returns:

the underlying object that this object is wrapping up.