Merge pull request prometheus#110 from pkubowicz/encapsulation

Make some missed fields private and/or final

Author: brian-brazil

simpleclient/src/main/java/io/prometheus/client/Collector.java

@@ -19,7 +19,7 @@ public abstract class Collector {
    * Return all of the metrics of this Collector.
    */
   public abstract List<MetricFamilySamples> collect();
-  public static enum Type {
+  public enum Type {
     COUNTER,
     GAUGE,
     SUMMARY,
@@ -140,9 +140,9 @@ public <T extends Collector> T register(CollectorRegistry registry) {
    */
   public static final double MILLISECONDS_PER_SECOND = 1E3;
 
-  protected static final Pattern METRIC_NAME_RE = Pattern.compile("[a-zA-Z_:][a-zA-Z0-9_:]*");
-  protected static final Pattern METRIC_LABEL_NAME_RE = Pattern.compile("[a-zA-Z_][a-zA-Z0-9_]*");
-  protected static final Pattern RESERVED_METRIC_LABEL_NAME_RE = Pattern.compile("__.*");
+  private static final Pattern METRIC_NAME_RE = Pattern.compile("[a-zA-Z_:][a-zA-Z0-9_:]*");
+  private static final Pattern METRIC_LABEL_NAME_RE = Pattern.compile("[a-zA-Z_][a-zA-Z0-9_]*");
+  private static final Pattern RESERVED_METRIC_LABEL_NAME_RE = Pattern.compile("__.*");
 
   /**
    * Throw an exception if the metric name is invalid.

simpleclient/src/main/java/io/prometheus/client/CollectorRegistry.java

@@ -114,7 +114,7 @@ public Double getSampleValue(String name, String[] labelNames, String[] labelVal
         if (sample.name.equals(name)
             && Arrays.equals(sample.labelNames.toArray(), labelNames)
             && Arrays.equals(sample.labelValues.toArray(), labelValues)) {
-          return new Double(sample.value);
+          return sample.value;
         }
       }
     }

simpleclient/src/main/java/io/prometheus/client/Histogram.java

@@ -51,7 +51,7 @@
  * offer easy ways to set common bucket patterns.
  */
 public class Histogram extends SimpleCollector<Histogram.Child> {
-  double[] buckets;
+  private final double[] buckets;
 
   Histogram(Builder b) {
     super(b);
@@ -60,7 +60,7 @@ public class Histogram extends SimpleCollector<Histogram.Child> {
   }
 
   public static class Builder extends SimpleCollector.Builder<Builder, Histogram> {
-    double[] buckets = new double[]{.005, .01, .025, .05, .075, .1, .25, .5, .75, 1, 2.5, 5, 7.5, 10};
+    private double[] buckets = new double[]{.005, .01, .025, .05, .075, .1, .25, .5, .75, 1, 2.5, 5, 7.5, 10};
 
     @Override
     public Histogram create() {
@@ -82,9 +82,7 @@ public Histogram create() {
       // Append infinity bucket if it's not already there.
       if (buckets[buckets.length - 1] != Double.POSITIVE_INFINITY) {
         double[] tmp = new double[buckets.length + 1];
-        for (int i = 0; i < buckets.length; i++) {
-          tmp[i] = buckets[i];
-        }
+        System.arraycopy(buckets, 0, tmp, 0, buckets.length);
         tmp[buckets.length] = Double.POSITIVE_INFINITY;
         buckets = tmp;
       }
@@ -139,8 +137,8 @@ protected Child newChild() {
    * Represents an event being timed.
    */
   public static class Timer {
-    Child child;
-    long start;
+    private final Child child;
+    private final long start;
     private Timer(Child child) {
       this.child = child;
       start = Child.timeProvider.nanoTime();
@@ -164,8 +162,13 @@ public double observeDuration() {
    */
   public static class Child {
     public static class Value {
-      public double sum;
-      public double[] buckets;
+      public final double sum;
+      public final double[] buckets;
+
+      public Value(double sum, double[] buckets) {
+        this.sum = sum;
+        this.buckets = buckets;
+      }
     }
 
     private Child(double[] buckets) {
@@ -175,9 +178,9 @@ private Child(double[] buckets) {
         cumulativeCounts[i] = new DoubleAdder();
       }
     }
-    private double[] upperBounds;
-    private DoubleAdder[] cumulativeCounts;
-    private DoubleAdder sum = new DoubleAdder();
+    private final double[] upperBounds;
+    private final DoubleAdder[] cumulativeCounts;
+    private final DoubleAdder sum = new DoubleAdder();
 
     static TimeProvider timeProvider = new TimeProvider();
     /**
@@ -207,15 +210,13 @@ public Timer startTimer() {
      * <em>Warning:</em> The definition of {@link Value} is subject to change.
      */
     public Value get() {
-      Value v = new Value();
-      v.buckets = new double[cumulativeCounts.length];
+      double[] buckets = new double[cumulativeCounts.length];
       double acc = 0;
       for (int i = 0; i < cumulativeCounts.length; ++i) {
         acc += cumulativeCounts[i].sum();
-        v.buckets[i] = acc;
+        buckets[i] = acc;
       }
-      v.sum = sum.sum();
-      return v;
+      return new Value(sum.sum(), buckets);
     }
   }
 
@@ -257,6 +258,10 @@ public List<MetricFamilySamples> collect() {
     return mfsList;
   }
 
+  double[] getBuckets() {
+    return buckets;
+  }
+
   static class TimeProvider {
     long nanoTime() {
       return System.nanoTime();

simpleclient/src/test/java/io/prometheus/client/HistogramTest.java

@@ -77,25 +77,25 @@ public void testBoundaryConditions() {
   @Test
   public void testManualBuckets() {
     Histogram h = Histogram.build().name("h").help("help").buckets(1, 2).create();
-    assertArrayEquals(new double[]{1, 2, Double.POSITIVE_INFINITY}, h.buckets, .001);
+    assertArrayEquals(new double[]{1, 2, Double.POSITIVE_INFINITY}, h.getBuckets(), .001);
   }
 
   @Test
   public void testManualBucketsInfinityAlreadyIncluded() {
     Histogram h = Histogram.build().buckets(1, 2, Double.POSITIVE_INFINITY).name("h").help("help").create();
-    assertArrayEquals(new double[]{1, 2, Double.POSITIVE_INFINITY}, h.buckets, .001);
+    assertArrayEquals(new double[]{1, 2, Double.POSITIVE_INFINITY}, h.getBuckets(), .001);
   }
 
   @Test
   public void testLinearBuckets() {
     Histogram h = Histogram.build().name("h").help("help").linearBuckets(1, 2, 3).create();
-    assertArrayEquals(new double[]{1, 3, 5, Double.POSITIVE_INFINITY}, h.buckets, .001);
+    assertArrayEquals(new double[]{1, 3, 5, Double.POSITIVE_INFINITY}, h.getBuckets(), .001);
   }
 
   @Test
   public void testExponentialBuckets() {
     Histogram h = Histogram.build().name("h").help("help").exponentialBuckets(2, 2.5, 3).create();
-    assertArrayEquals(new double[]{2, 5, 12.5, Double.POSITIVE_INFINITY}, h.buckets, .001);
+    assertArrayEquals(new double[]{2, 5, 12.5, Double.POSITIVE_INFINITY}, h.getBuckets(), .001);
   }
 
   @Test