MetricsRegistry (Hadoop 0.20.2-cdh3u1 API)
Date: 2011-07-18

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.hadoop.metrics.util
Class MetricsRegistry

    java.lang.Object
      org.apache.hadoop.metrics.util.MetricsRegistry

    public class MetricsRegistry

extends Object

This is the registry for metrics. Related set of metrics should be declared in a holding class and registered in a registry for those metrics which is also stored in the the holding class.

Constructor Summary
`MetricsRegistry()`

Method Summary
`void` | `add(String metricsName, MetricsBase theMetricsObj)` Add a new metrics to the registry
`MetricsBase` | `get(String metricsName)`
`Collection<String>` | `getKeyList()`
`Collection<MetricsBase>` | `getMetricsList()`
`int` | `size()`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### MetricsRegistry

    public MetricsRegistry()

Method Detail

### size

    public int size()

  Returns:
    number of metrics in the registry

### add

    public void add(String metricsName,
                    MetricsBase theMetricsObj)

  Add a new metrics to the registry

  Parameters:
    `metricsName` - - the name
    `theMetricsObj` - - the metrics
  Throws:
    `IllegalArgumentException` - if a name is already registered

### get

    public MetricsBase get(String metricsName)

  Parameters:
    `metricsName` -
  Returns:
    the metrics if there is one registered by the supplied name. Returns null if none is registered

### getKeyList

    public Collection<String> getKeyList()

  Returns:
    the list of metrics names

### getMetricsList

    public Collection<MetricsBase> getMetricsList()

  Returns:
    the list of metrics

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2009 The Apache Software Foundation