org.apache.hadoop.mapreduce.counters
Class FrameworkCounterGroup.FrameworkCounter

java.lang.Object
  extended by org.apache.hadoop.mapreduce.counters.AbstractCounter
      extended by org.apache.hadoop.mapreduce.counters.FrameworkCounterGroup.FrameworkCounter
All Implemented Interfaces:
org.apache.hadoop.io.Writable, Counter
Enclosing class:
FrameworkCounterGroup<T extends java.lang.Enum<T>,C extends Counter>

@InterfaceAudience.Private
public class FrameworkCounterGroup.FrameworkCounter
extends AbstractCounter

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


Constructor Summary
FrameworkCounterGroup.FrameworkCounter(T ref)
           
 
Method Summary
 java.lang.String getDisplayName()
          Get the display name of the counter.
 java.lang.String getName()
           
 Counter 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(java.io.DataInput in)
           
 void setValue(long value)
          Set this counter by the given value
 void write(java.io.DataOutput out)
           
 
Methods inherited from class org.apache.hadoop.mapreduce.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)
Method Detail

getName

public java.lang.String getName()
Returns:
the name of the counter

getDisplayName

public java.lang.String getDisplayName()
Description copied from interface: Counter
Get the display name of the counter.

Returns:
the user facing name of the counter

getValue

public long getValue()
Description copied from interface: Counter
What is the current value of this counter?

Returns:
the current value

setValue

public void setValue(long value)
Description copied from interface: Counter
Set this counter by the given value

Parameters:
value - the value to set

increment

public void increment(long incr)
Description copied from interface: Counter
Increment this counter by the given value

Parameters:
incr - the value to increase this counter by

write

public void write(java.io.DataOutput out)
           throws java.io.IOException
Throws:
java.io.IOException

readFields

public void readFields(java.io.DataInput in)
                throws java.io.IOException
Throws:
java.io.IOException

getUnderlyingCounter

public Counter getUnderlyingCounter()
Description copied from interface: Counter
Return the underlying object if this is a facade.

Returns:
the undelying object.


Copyright © 2009 The Apache Software Foundation