Minor cleanup in the Metrics module:
* Add missing Javadoc
* Line formatting
No functional changes.
diff --git a/utils/misc/src/main/java/org/onlab/metrics/MetricsComponent.java b/utils/misc/src/main/java/org/onlab/metrics/MetricsComponent.java
index 996fa6f1..36064e4 100644
--- a/utils/misc/src/main/java/org/onlab/metrics/MetricsComponent.java
+++ b/utils/misc/src/main/java/org/onlab/metrics/MetricsComponent.java
@@ -24,14 +24,17 @@
name = newName;
}
- @Override public String getName() {
+ @Override
+ public String getName() {
return name;
}
- @Override public MetricsFeature registerFeature(final String featureName) {
+ @Override
+ public MetricsFeature registerFeature(final String featureName) {
MetricsFeature feature = featuresRegistry.get(featureName);
if (feature == null) {
- final MetricsFeature createdFeature = new MetricsFeature(featureName);
+ final MetricsFeature createdFeature =
+ new MetricsFeature(featureName);
feature = featuresRegistry.putIfAbsent(featureName, createdFeature);
if (feature == null) {
feature = createdFeature;
diff --git a/utils/misc/src/main/java/org/onlab/metrics/MetricsComponentRegistry.java b/utils/misc/src/main/java/org/onlab/metrics/MetricsComponentRegistry.java
index 1602de6..a28ddc8 100644
--- a/utils/misc/src/main/java/org/onlab/metrics/MetricsComponentRegistry.java
+++ b/utils/misc/src/main/java/org/onlab/metrics/MetricsComponentRegistry.java
@@ -4,7 +4,18 @@
* Registry Entry for Metrics Components.
*/
public interface MetricsComponentRegistry {
+ /**
+ * Fetches the name of the Component.
+ *
+ * @return name of the Component
+ */
String getName();
+ /**
+ * Registers a Feature for this component.
+ *
+ * @param featureName name of the Feature to register
+ * @return Feature object that can be used when creating Metrics
+ */
MetricsFeature registerFeature(String featureName);
}
diff --git a/utils/misc/src/main/java/org/onlab/metrics/MetricsFeature.java b/utils/misc/src/main/java/org/onlab/metrics/MetricsFeature.java
index 75c1018..204f562 100644
--- a/utils/misc/src/main/java/org/onlab/metrics/MetricsFeature.java
+++ b/utils/misc/src/main/java/org/onlab/metrics/MetricsFeature.java
@@ -15,6 +15,11 @@
name = newName;
}
+ /**
+ * Fetches the name of the Feature.
+ *
+ * @return name of the Feature
+ */
public String getName() {
return name;
}