[lucene-solr] 01/02: SOLR-13733: add class-level javadocs for 4 org.apache.solr.metrics classes

[cp...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

cpoerschke pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/lucene-solr.git

commit 6f12075e9aea61b752bd2fdcbb2a4eb3ade17f31
Author: Christine Poerschke <cp...@apache.org>
AuthorDate: Wed Sep 4 15:50:41 2019 +0100

    SOLR-13733: add class-level javadocs for 4 org.apache.solr.metrics classes
---
 .../java/org/apache/solr/metrics/FilteringSolrMetricReporter.java | 3 +++
 solr/core/src/java/org/apache/solr/metrics/SolrMetricManager.java | 8 ++++++++
 .../org/apache/solr/metrics/reporters/jmx/JmxMetricsReporter.java | 3 +++
 .../java/org/apache/solr/metrics/reporters/solr/SolrReporter.java | 3 +++
 4 files changed, 17 insertions(+)

diff --git a/solr/core/src/java/org/apache/solr/metrics/FilteringSolrMetricReporter.java b/solr/core/src/java/org/apache/solr/metrics/FilteringSolrMetricReporter.java
index 5f29f8e..9ef1fb7 100644
--- a/solr/core/src/java/org/apache/solr/metrics/FilteringSolrMetricReporter.java
+++ b/solr/core/src/java/org/apache/solr/metrics/FilteringSolrMetricReporter.java
@@ -21,6 +21,9 @@ import java.util.List;
 
 import com.codahale.metrics.MetricFilter;
 
+/**
+ * A {@link SolrMetricReporter} that supports (prefix) filters.
+ */
 public abstract class FilteringSolrMetricReporter extends SolrMetricReporter {
 
   protected List<String> filters = new ArrayList<>();
diff --git a/solr/core/src/java/org/apache/solr/metrics/SolrMetricManager.java b/solr/core/src/java/org/apache/solr/metrics/SolrMetricManager.java
index a8a1a4f..187598d 100644
--- a/solr/core/src/java/org/apache/solr/metrics/SolrMetricManager.java
+++ b/solr/core/src/java/org/apache/solr/metrics/SolrMetricManager.java
@@ -293,6 +293,10 @@ public class SolrMetricManager {
     }
   }
 
+  /**
+   * An implementation of {@link MetricFilter} that selects metrics
+   * that match any filter in a list of filters.
+   */
   public static class OrFilter implements MetricFilter {
     List<MetricFilter> filters = new ArrayList<>();
 
@@ -323,6 +327,10 @@ public class SolrMetricManager {
     }
   }
 
+  /**
+   * An implementation of {@link MetricFilter} that selects metrics
+   * that match all filters in a list of filters.
+   */
   public static class AndFilter implements MetricFilter {
     List<MetricFilter> filters = new ArrayList<>();
 
diff --git a/solr/core/src/java/org/apache/solr/metrics/reporters/jmx/JmxMetricsReporter.java b/solr/core/src/java/org/apache/solr/metrics/reporters/jmx/JmxMetricsReporter.java
index f7fb066..189d14d 100644
--- a/solr/core/src/java/org/apache/solr/metrics/reporters/jmx/JmxMetricsReporter.java
+++ b/solr/core/src/java/org/apache/solr/metrics/reporters/jmx/JmxMetricsReporter.java
@@ -73,6 +73,9 @@ public class JmxMetricsReporter implements Reporter, Closeable {
     return new Builder(registry);
   }
 
+  /**
+   * Builder for the {@link JmxMetricsReporter} class.
+   */
   public static class Builder {
     private final MetricRegistry registry;
     private MBeanServer mBeanServer;
diff --git a/solr/core/src/java/org/apache/solr/metrics/reporters/solr/SolrReporter.java b/solr/core/src/java/org/apache/solr/metrics/reporters/solr/SolrReporter.java
index 7055f52..5a83cd9 100644
--- a/solr/core/src/java/org/apache/solr/metrics/reporters/solr/SolrReporter.java
+++ b/solr/core/src/java/org/apache/solr/metrics/reporters/solr/SolrReporter.java
@@ -116,6 +116,9 @@ public class SolrReporter extends ScheduledReporter {
     }
   }
 
+  /**
+   * Builder for the {@link SolrReporter} class.
+   */
   public static class Builder {
     private final SolrMetricManager metricManager;
     private final List<Report> reports;