Counters (Apache Hadoop Main 3.0.0-alpha2-SNAPSHOT API)

java.lang.Object
- org.apache.hadoop.mapreduce.counters.AbstractCounters<Counters.Counter,Counters.Group>
- - org.apache.hadoop.mapred.Counters

すべての実装されたインタフェース:

Iterable<Counters.Group>, Writable
```
@InterfaceAudience.Public
 @InterfaceStability.Stable
public class Counters
extends AbstractCounters<Counters.Counter,Counters.Group>
```
A set of named counters.
Counters represent global counters, defined either by the Map-Reduce framework or applications. Each Counter can be of any Enum type.

Counters are bunched into Counters.Groups, each comprising of counters from a particular Enum class.

ネストされたクラスのサマリー

ネストされたクラス
修飾子とタイプ	クラスと説明
`static class`	`Counters.Counter` A counter record, comprising its name and value.
`static class`	`Counters.Group` `Group` of counters, comprising of counters from a particular counter `Enum` class.

フィールドのサマリー

フィールド
修飾子とタイプフィールドと説明

static int MAX_COUNTER_LIMIT

static int MAX_GROUP_LIMIT
- クラスから継承されたフィールド org.apache.hadoop.mapreduce.counters.AbstractCounters
  LOG

フィールド
修飾子とタイプ	フィールドと説明
`static int`	`MAX_COUNTER_LIMIT`
`static int`	`MAX_GROUP_LIMIT`

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

Counters()

Counters(Counters newCounters)

コンストラクタ
コンストラクタと説明
`Counters()`
`Counters(Counters newCounters)`

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド非推奨のメソッド
修飾子とタイプ	メソッドと説明
`Counters.Counter`	`findCounter(String group, int id, String name)` 非推奨です。 use `findCounter(String, String)` instead
`Counters.Counter`	`findCounter(String group, String name)` Find a counter, create one if necessary
`static Counters`	`fromEscapedCompactString(String compactString)` Convert a stringified (by `makeEscapedCompactString()` counter representation into a counter object.
`long`	`getCounter(Enum<?> key)` Returns current value of the specified counter, or 0 if the counter does not exist.
`Counters.Group`	`getGroup(String groupName)` Returns the named counter group, or an empty group if there is none with the specified name.
`Collection<String>`	`getGroupNames()` Returns the names of all counter classes.
`void`	`incrAllCounters(Counters other)` Increments multiple counters by their amounts in another Counters instance.
`void`	`incrCounter(Enum<?> key, long amount)` Increments the specified counter by the specified amount, creating it if it didn't already exist.
`void`	`incrCounter(String group, String counter, long amount)` Increments the specified counter by the specified amount, creating it if it didn't already exist.
`void`	`log(org.apache.commons.logging.Log log)` Logs the current counter values.
`String`	`makeCompactString()`
`String`	`makeEscapedCompactString()` Represent the counter in a textual format that can be converted back to its object form
`int`	`size()` 非推奨です。 use `AbstractCounters.countCounters()` instead
`static Counters`	`sum(Counters a, Counters b)` Convenience method for computing the sum of two sets of counters.

クラスから継承されたメソッド org.apache.hadoop.mapreduce.counters.AbstractCounters
countCounters, equals, findCounter, hashCode, incrAllCounters, iterator, readFields, toString, write

クラスから継承されたメソッド java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

インタフェースから継承されたメソッド java.lang.Iterable
forEach, spliterator

- フィールドの詳細
  - MAX_COUNTER_LIMIT
```
public static final int MAX_COUNTER_LIMIT
```
  - MAX_GROUP_LIMIT
```
public static final int MAX_GROUP_LIMIT
```
- コンストラクタの詳細
  - Counters
```
public Counters()
```
  - Counters
```
public Counters(Counters newCounters)
```
- メソッドの詳細
  - getGroup
```
public Counters.Group getGroup(String groupName)
```
    クラスからコピーされた説明: AbstractCounters
    
    Returns the named counter group, or an empty group if there is none with the specified name.
    
    オーバーライド:
    
    getGroup クラス内 AbstractCounters<Counters.Counter,Counters.Group>
    
    パラメータ:
    
    groupName - name of the group
    
    戻り値:
    
    the group
  - getGroupNames
```
public Collection<String> getGroupNames()
```
    クラスからコピーされた説明: AbstractCounters
    
    Returns the names of all counter classes.
    
    オーバーライド:
    
    getGroupNames クラス内 AbstractCounters<Counters.Counter,Counters.Group>
    
    戻り値:
    
    Set of counter names.
  - makeCompactString
```
public String makeCompactString()
```
  - findCounter
```
public Counters.Counter findCounter(String group,
                                    String name)
```
    クラスからコピーされた説明: AbstractCounters
    
    Find a counter, create one if necessary
    
    オーバーライド:
    
    findCounter クラス内 AbstractCounters<Counters.Counter,Counters.Group>
    
    パラメータ:
    
    group - of the counter
    
    name - name of the counter
    
    戻り値:
    
    the matching counter
  - findCounter
```
@Deprecated
public Counters.Counter findCounter(String group,
                                                int id,
                                                String name)
```
    非推奨です。 use findCounter(String, String) instead
    
    Find a counter by using strings
    
    パラメータ:
    
    group - the name of the group
    
    id - the id of the counter within the group (0 to N-1)
    
    name - the internal name of the counter
    
    戻り値:
    
    the counter for that name
  - incrCounter
```
public void incrCounter(Enum<?> key,
                        long amount)
```
    Increments the specified counter by the specified amount, creating it if it didn't already exist.
    
    パラメータ:
    
    key - identifies a counter
    
    amount - amount by which counter is to be incremented
  - incrCounter
```
public void incrCounter(String group,
                        String counter,
                        long amount)
```
    Increments the specified counter by the specified amount, creating it if it didn't already exist.
    
    パラメータ:
    
    group - the name of the group
    
    counter - the internal name of the counter
    
    amount - amount by which counter is to be incremented
  - getCounter
```
public long getCounter(Enum<?> key)
```
    Returns current value of the specified counter, or 0 if the counter does not exist.
    
    パラメータ:
    
    key - the counter enum to lookup
    
    戻り値:
    
    the counter value or 0 if counter not found
  - incrAllCounters
```
public void incrAllCounters(Counters other)
```
    Increments multiple counters by their amounts in another Counters instance.
    
    パラメータ:
    
    other - the other Counters instance
  - size
```
public int size()
```
    非推奨です。 use AbstractCounters.countCounters() instead
    
    戻り値:
    
    the total number of counters
  - sum
```
public static Counters sum(Counters a,
                           Counters b)
```
    Convenience method for computing the sum of two sets of counters.
    
    パラメータ:
    
    a - the first counters
    
    b - the second counters
    
    戻り値:
    
    a new summed counters object
  - log
```
public void log(org.apache.commons.logging.Log log)
```
    Logs the current counter values.
    
    パラメータ:
    
    log - The log to use.
  - makeEscapedCompactString
```
public String makeEscapedCompactString()
```
    Represent the counter in a textual format that can be converted back to its object form
    
    戻り値:
    
    the string in the following format {(groupName)(group-displayName)[(counterName)(displayName)(value)][]*}*
  - fromEscapedCompactString
```
public static Counters fromEscapedCompactString(String compactString)
                                         throws ParseException
```
    Convert a stringified (by makeEscapedCompactString() counter representation into a counter object.
    
    パラメータ:
    
    compactString - to parse
    
    戻り値:
    
    a new counters object
    
    例外:
    
    ParseException

クラス Counters

ネストされたクラスのサマリー

フィールドのサマリー

クラスから継承されたフィールド org.apache.hadoop.mapreduce.counters.AbstractCounters

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド org.apache.hadoop.mapreduce.counters.AbstractCounters

クラスから継承されたメソッド java.lang.Object

インタフェースから継承されたメソッド java.lang.Iterable

フィールドの詳細

MAX_COUNTER_LIMIT

MAX_GROUP_LIMIT

コンストラクタの詳細

Counters

Counters

メソッドの詳細

getGroup

getGroupNames

makeCompactString

findCounter

findCounter

incrCounter

incrCounter

getCounter

incrAllCounters

size

sum

log

makeEscapedCompactString

fromEscapedCompactString