org.apache.tez.common.counters

Class FrameworkCounterGroup.FrameworkCounter<T extends Enum<T>>

java.lang.Object

org.apache.tez.common.counters.AbstractCounter

org.apache.tez.common.counters.FrameworkCounterGroup.FrameworkCounter<T>

All Implemented Interfaces:

org.apache.hadoop.io.Writable, TezCounter

Enclosing class:

FrameworkCounterGroup<T extends Enum<T>,C extends TezCounter>

@InterfaceAudience.Private
public static class FrameworkCounterGroup.FrameworkCounter<T extends Enum<T>>
extends AbstractCounter

A counter facade for framework counters. Use old (which extends new) interface to make compatibility easier.

Constructor Summary

Constructors

Constructor and Description
FrameworkCounterGroup.FrameworkCounter(T ref, String groupName)

Method Summary

Methods

Modifier and Type	Method and Description
String	getDisplayName() Get the display name of the counter.
String	getName()
TezCounter	getUnderlyingCounter() Return the underlying object if this is a facade.
long	getValue() What is the current value of this counter?
void	increment(long incr) Increment this counter by the given value
void	readFields(DataInput in)
void	setValue(long value) Set this counter by the given value
void	write(DataOutput out)

Methods inherited from class org.apache.tez.common.counters.AbstractCounter

equals, hashCode, setDisplayName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FrameworkCounterGroup.FrameworkCounter

public FrameworkCounterGroup.FrameworkCounter(T ref,
                                      String groupName)

Method Detail

getName

public String getName()

Returns:

the name of the counter

getDisplayName

public String getDisplayName()

Description copied from interface: TezCounter

Get the display name of the counter.

Returns:

the user facing name of the counter

getValue

public long getValue()

Description copied from interface: TezCounter

What is the current value of this counter?

Returns:

the current value

setValue

public void setValue(long value)

Description copied from interface: TezCounter

Set this counter by the given value

Parameters:

value - the value to set

increment

public void increment(long incr)

Description copied from interface: TezCounter

Increment this counter by the given value

Parameters:

incr - the value to increase this counter by

write

public void write(DataOutput out)
           throws IOException

Throws:

IOException

readFields

public void readFields(DataInput in)
                throws IOException

Throws:

IOException

getUnderlyingCounter

public TezCounter getUnderlyingCounter()

Description copied from interface: TezCounter

Return the underlying object if this is a facade.

Returns:

the undelying object.