commit 95caf26296293c4a1c9c94ae54e0b14182e8261f
author Pavlin Radoslavov <pavlin@onlab.us> Fri Jul 18 12:53:42 2014 -0700
committer Pavlin Radoslavov <pavlin@onlab.us> Fri Jul 18 15:04:02 2014 -0700
tree dad622323dcba915305380a36966f819825def8c
parent 40eb9c88e31b29325fe5764df2fa26c24bb11b7a

Minor updates to the OnosMetrics API:

 * Modified method OnosMetrics.registerMetric() to return the registered
   metric, and use Generics to specify the Metric return type.
   Thus, we can allocate and register a gauge when the gauge is declared. E.g.:

class Foo {
    private Final Gauge<Long> gauge =
        OnosMetrics.registerMetric(COMPONENT, FEATURE, "MyGauge",
            new Gauge<Long() { ... });

Also, minor updates to some of the Javadoc text.

Change-Id: Idccfaf056be7ee707114e5b3e39d9a6b3f7808cf

src/main/java/net/onrc/onos/core/metrics/OnosMetrics.java

diff --git a/src/main/java/net/onrc/onos/core/metrics/OnosMetrics.java b/src/main/java/net/onrc/onos/core/metrics/OnosMetrics.java
index a299407..d163335 100644
--- a/src/main/java/net/onrc/onos/core/metrics/OnosMetrics.java
+++ b/src/main/java/net/onrc/onos/core/metrics/OnosMetrics.java
@@ -202,7 +202,7 @@
      * @param component component the Counter is defined in
      * @param feature feature the Counter is defined in
      * @param metricName local name of the metric
-     * @return Counter Meteric
+     * @return the created Counter Meteric
      */
     public static Counter createCounter(final MetricsComponent component,
                                         final MetricsFeature feature,
@@ -217,7 +217,7 @@
      * @param component component the Histogram is defined in
      * @param feature feature the Histogram is defined in
      * @param metricName local name of the metric
-     * @return Histogram Metric
+     * @return the created Histogram Metric
      */
     public static Histogram createHistogram(final MetricsComponent component,
                                             final MetricsFeature feature,
@@ -232,7 +232,7 @@
      * @param component component the Timer is defined in
      * @param feature feature the Timeer is defined in
      * @param metricName local name of the metric
-     * @return Timer Metric
+     * @return the created Timer Metric
      */
     public static Timer createTimer(final MetricsComponent component,
                                     final MetricsFeature feature,
@@ -247,7 +247,7 @@
      * @param component component the Meter is defined in
      * @param feature feature the Meter is defined in
      * @param metricName local name of the metric
-     * @return Meter Metric
+     * @return the created Meter Metric
      */
     public static Meter createMeter(final MetricsComponent component,
                                     final MetricsFeature feature,
@@ -262,16 +262,19 @@
      * system.
      *
      * @param component component the Metric is defined in
-     * @param feature feature the metric is defined in
+     * @param feature feature the Metric is defined in
      * @param metricName local name of the metric
      * @param metric Metric to register
+     * @return the registered Metric
      */
-    public static void registerMetric(final MetricsComponent component,
-                                      final MetricsFeature feature,
-                                      final String metricName,
-                                      final Metric metric) {
+    public static <T extends Metric> T registerMetric(
+                                        final MetricsComponent component,
+                                        final MetricsFeature feature,
+                                        final String metricName,
+                                        final T metric) {
         final String name = generateName(component, feature, metricName);
         METRICS_REGISTRY.register(name, metric);
+        return metric;
     }
 
     /**