Rename StatsRecord to MeasureMap (#757)

Author: songy23

…ava/io/opencensus/stats/StatsRecord.java …java/io/opencensus/stats/MeasureMap.javaapi/src/main/java/io/opencensus/stats/StatsRecord.java renamed to api/src/main/java/io/opencensus/stats/MeasureMap.java api/src/main/java/io/opencensus/stats/StatsRecord.java renamed to api/src/main/java/io/opencensus/stats/MeasureMap.java

@@ -23,7 +23,7 @@
 
 /** A map from {@link Measure}s to measured values to be recorded at the same time. */
 @NotThreadSafe
-public abstract class StatsRecord {
+public abstract class MeasureMap {
 
   /**
    * Associates the {@link MeasureDouble} with the given value. Subsequent updates to the same
@@ -33,7 +33,7 @@ public abstract class StatsRecord {
    * @param value the value to be associated with {@code measure}
    * @return this
    */
-  public abstract StatsRecord put(MeasureDouble measure, double value);
+  public abstract MeasureMap put(MeasureDouble measure, double value);
 
   /**
    * Associates the {@link MeasureLong} with the given value. Subsequent updates to the same {@link
@@ -43,19 +43,19 @@ public abstract class StatsRecord {
    * @param value the value to be associated with {@code measure}
    * @return this
    */
-  public abstract StatsRecord put(MeasureLong measure, long value);
+  public abstract MeasureMap put(MeasureLong measure, long value);
 
   /**
    * Records all of the measures at the same time, with the current {@link TagContext}.
    *
-   * <p>This method records all of the stats in the {@code StatsRecord} every time it is called.
+   * <p>This method records all of the stats in the {@code MeasureMap} every time it is called.
    */
   public abstract void record();
 
   /**
    * Records all of the measures at the same time, with an explicit {@link TagContext}.
    *
-   * <p>This method records all of the stats in the {@code StatsRecord} every time it is called.
+   * <p>This method records all of the stats in the {@code MeasureMap} every time it is called.
    *
    * @param tags the tags associated with the measurements.
    */

api/src/main/java/io/opencensus/stats/NoopStats.java

@@ -61,12 +61,12 @@ static StatsRecorder getNoopStatsRecorder() {
   }
 
   /**
-   * Returns a {@code StatsRecord} that ignores all calls to {@link StatsRecord#put}.
+   * Returns a {@code MeasureMap} that ignores all calls to {@link MeasureMap#put}.
    *
-   * @return a {@code StatsRecord} that ignores all calls to {@code StatsRecord#put}.
+   * @return a {@code MeasureMap} that ignores all calls to {@code MeasureMap#put}.
    */
-  static StatsRecord getNoopStatsRecord() {
-    return NoopStatsRecord.INSTANCE;
+  static MeasureMap getNoopMeasureMap() {
+    return NoopMeasureMap.INSTANCE;
   }
 
   /**
@@ -110,22 +110,22 @@ private static final class NoopStatsRecorder extends StatsRecorder {
     static final StatsRecorder INSTANCE = new NoopStatsRecorder();
 
     @Override
-    public StatsRecord newRecord() {
-      return getNoopStatsRecord();
+    public MeasureMap newMeasureMap() {
+      return getNoopMeasureMap();
     }
   }
 
   @Immutable
-  private static final class NoopStatsRecord extends StatsRecord {
-    static final StatsRecord INSTANCE = new NoopStatsRecord();
+  private static final class NoopMeasureMap extends MeasureMap {
+    static final MeasureMap INSTANCE = new NoopMeasureMap();
 
     @Override
-    public StatsRecord put(MeasureDouble measure, double value) {
+    public MeasureMap put(MeasureDouble measure, double value) {
       return this;
     }
 
     @Override
-    public StatsRecord put(MeasureLong measure, long value) {
+    public MeasureMap put(MeasureLong measure, long value) {
       return this;
     }
 

api/src/main/java/io/opencensus/stats/StatsRecorder.java

@@ -25,5 +25,5 @@ public abstract class StatsRecorder {
    *
    * @return an object for recording multiple measurements.
    */
-  public abstract StatsRecord newRecord();
+  public abstract MeasureMap newMeasureMap();
 }

api/src/test/java/io/opencensus/stats/NoopStatsTest.java

@@ -85,7 +85,7 @@ public void noopStatsComponent_SetState_DisallowsNull() {
   @Test
   public void noopStatsRecorder_Record() {
     NoopStats.getNoopStatsRecorder()
-        .newRecord()
+        .newMeasureMap()
         .put(MEASURE, 5)
         .record(tagContext);
   }
@@ -94,13 +94,13 @@ public void noopStatsRecorder_Record() {
   // exception.
   @Test
   public void noopStatsRecorder_RecordWithCurrentContext() {
-    NoopStats.getNoopStatsRecorder().newRecord().put(MEASURE, 6).record();
+    NoopStats.getNoopStatsRecorder().newMeasureMap().put(MEASURE, 6).record();
   }
 
   @Test
   public void noopStatsRecorder_Record_DisallowNullTagContext() {
-    StatsRecord record = NoopStats.getNoopStatsRecorder().newRecord();
+    MeasureMap measureMap = NoopStats.getNoopStatsRecorder().newMeasureMap();
     thrown.expect(NullPointerException.class);
-    record.record(null);
+    measureMap.record(null);
   }
 }

…nsus/implcore/stats/StatsRecordImpl.java …ensus/implcore/stats/MeasureMapImpl.javacore_impl/src/main/java/io/opencensus/implcore/stats/StatsRecordImpl.java renamed to core_impl/src/main/java/io/opencensus/implcore/stats/MeasureMapImpl.java core_impl/src/main/java/io/opencensus/implcore/stats/StatsRecordImpl.java renamed to core_impl/src/main/java/io/opencensus/implcore/stats/MeasureMapImpl.java

@@ -18,31 +18,31 @@
 
 import io.opencensus.stats.Measure.MeasureDouble;
 import io.opencensus.stats.Measure.MeasureLong;
-import io.opencensus.stats.StatsRecord;
+import io.opencensus.stats.MeasureMap;
 import io.opencensus.tags.TagContext;
 import io.opencensus.tags.unsafe.ContextUtils;
 
-/** Implementation of {@link StatsRecord}. */
-final class StatsRecordImpl extends StatsRecord {
+/** Implementation of {@link MeasureMap}. */
+final class MeasureMapImpl extends MeasureMap {
   private final StatsManager statsManager;
-  private final MeasureMap.Builder builder = MeasureMap.builder();
+  private final MeasureMapInternal.Builder builder = MeasureMapInternal.builder();
 
-  static StatsRecordImpl create(StatsManager statsManager) {
-    return new StatsRecordImpl(statsManager);
+  static MeasureMapImpl create(StatsManager statsManager) {
+    return new MeasureMapImpl(statsManager);
   }
 
-  private StatsRecordImpl(StatsManager statsManager) {
+  private MeasureMapImpl(StatsManager statsManager) {
     this.statsManager = statsManager;
   }
 
   @Override
-  public StatsRecordImpl put(MeasureDouble measure, double value) {
+  public MeasureMapImpl put(MeasureDouble measure, double value) {
     builder.put(measure, value);
     return this;
   }
 
   @Override
-  public StatsRecordImpl put(MeasureLong measure, long value) {
+  public MeasureMapImpl put(MeasureLong measure, long value) {
     builder.put(measure, value);
     return this;
   }

…pencensus/implcore/stats/MeasureMap.java …s/implcore/stats/MeasureMapInternal.javacore_impl/src/main/java/io/opencensus/implcore/stats/MeasureMap.java renamed to core_impl/src/main/java/io/opencensus/implcore/stats/MeasureMapInternal.java core_impl/src/main/java/io/opencensus/implcore/stats/MeasureMap.java renamed to core_impl/src/main/java/io/opencensus/implcore/stats/MeasureMapInternal.java

@@ -24,34 +24,35 @@
 import java.util.Iterator;
 import java.util.NoSuchElementException;
 
+// TODO(songya): consider combining MeasureMapImpl and this class.
 /**
  * A map from {@link Measure}'s to measured values.
  */
-final class MeasureMap {
+final class MeasureMapInternal {
 
   /**
-   * Returns a {@link Builder} for the {@link MeasureMap} class.
+   * Returns a {@link Builder} for the {@link MeasureMapInternal} class.
    */
   static Builder builder() {
     return new Builder();
   }
 
   /**
-   * Returns an {@link Iterator} over the measure/value mappings in this {@link MeasureMap}.
+   * Returns an {@link Iterator} over the measure/value mappings in this {@link MeasureMapInternal}.
    * The {@code Iterator} does not support {@link Iterator#remove()}.
    */
   Iterator<Measurement> iterator() {
-    return new MeasureMapIterator();
+    return new MeasureMapInternalIterator();
   }
 
   private final ArrayList<Measurement> measurements;
 
-  private MeasureMap(ArrayList<Measurement> measurements) {
+  private MeasureMapInternal(ArrayList<Measurement> measurements) {
     this.measurements = measurements;
   }
 
   /**
-   * Builder for the {@link MeasureMap} class.
+   * Builder for the {@link MeasureMapInternal} class.
    */
   static class Builder {
     /**
@@ -81,12 +82,12 @@ Builder put(MeasureLong measure, long value) {
     }
 
     /**
-     * Constructs a {@link MeasureMap} from the current measurements.
+     * Constructs a {@link MeasureMapInternal} from the current measurements.
      */
-    MeasureMap build() {
+    MeasureMapInternal build() {
       // Note: this makes adding measurements quadratic but is fastest for the sizes of
-      // MeasureMaps that we should see. We may want to go to a strategy of sort/eliminate
-      // for larger MeasureMaps.
+      // MeasureMapInternals that we should see. We may want to go to a strategy of sort/eliminate
+      // for larger MeasureMapInternals.
       for (int i = measurements.size() - 1; i >= 0; i--) {
         for (int j = i - 1; j >= 0; j--) {
           if (measurements.get(i).getMeasure() == measurements.get(j).getMeasure()) {
@@ -95,7 +96,7 @@ MeasureMap build() {
           }
         }
       }
-      return new MeasureMap(measurements);
+      return new MeasureMapInternal(measurements);
     }
 
     private final ArrayList<Measurement> measurements = new ArrayList<Measurement>();
@@ -105,7 +106,7 @@ private Builder() {
   }
 
   // Provides an unmodifiable Iterator over this instance's measurements.
-  private final class MeasureMapIterator implements Iterator<Measurement> {
+  private final class MeasureMapInternalIterator implements Iterator<Measurement> {
     @Override
     public boolean hasNext() {
       return position < length;

core_impl/src/main/java/io/opencensus/implcore/stats/MeasureToViewMap.java

@@ -108,7 +108,7 @@ synchronized void registerView(View view, Clock clock) {
   }
 
   // Records stats with a set of tags.
-  synchronized void record(TagContext tags, MeasureMap stats, Timestamp timestamp) {
+  synchronized void record(TagContext tags, MeasureMapInternal stats, Timestamp timestamp) {
     Iterator<Measurement> iterator = stats.iterator();
     while (iterator.hasNext()) {
       Measurement measurement = iterator.next();

core_impl/src/main/java/io/opencensus/implcore/stats/StatsManager.java

@@ -49,17 +49,17 @@ ViewData getView(View.Name viewName) {
     return measureToViewMap.getView(viewName, clock);
   }
 
-  void record(TagContext tags, MeasureMap measurementValues) {
+  void record(TagContext tags, MeasureMapInternal measurementValues) {
     queue.enqueue(new StatsEvent(this, tags, measurementValues));
   }
 
   // An EventQueue entry that records the stats from one call to StatsManager.record(...).
   private static final class StatsEvent implements EventQueue.Entry {
     private final TagContext tags;
-    private final MeasureMap stats;
+    private final MeasureMapInternal stats;
     private final StatsManager statsManager;
 
-    StatsEvent(StatsManager statsManager, TagContext tags, MeasureMap stats) {
+    StatsEvent(StatsManager statsManager, TagContext tags, MeasureMapInternal stats) {
       this.statsManager = statsManager;
       this.tags = tags;
       this.stats = stats;

core_impl/src/main/java/io/opencensus/implcore/stats/StatsRecorderImpl.java

@@ -30,7 +30,7 @@ public final class StatsRecorderImpl extends StatsRecorder {
   }
 
   @Override
-  public StatsRecordImpl newRecord() {
-    return StatsRecordImpl.create(statsManager);
+  public MeasureMapImpl newMeasureMap() {
+    return MeasureMapImpl.create(statsManager);
   }
 }

…ensus/implcore/stats/MeasureMapTest.java …plcore/stats/MeasureMapInternalTest.javacore_impl/src/test/java/io/opencensus/implcore/stats/MeasureMapTest.java renamed to core_impl/src/test/java/io/opencensus/implcore/stats/MeasureMapInternalTest.java core_impl/src/test/java/io/opencensus/implcore/stats/MeasureMapTest.java renamed to core_impl/src/test/java/io/opencensus/implcore/stats/MeasureMapInternalTest.java

@@ -30,28 +30,29 @@
 import org.junit.runner.RunWith;
 import org.junit.runners.JUnit4;
 
-/** Tests for {@link MeasureMap}. */
+/** Tests for {@link MeasureMapInternal}. */
 @RunWith(JUnit4.class)
-public class MeasureMapTest {
+public class MeasureMapInternalTest {
 
   @Test
   public void testPutDouble() {
-    MeasureMap metrics = MeasureMap.builder().put(M1, 44.4).build();
+    MeasureMapInternal metrics = MeasureMapInternal.builder().put(M1, 44.4).build();
     assertContains(metrics, MeasurementDouble.create(M1, 44.4));
   }
 
   @Test
   public void testPutLong() {
-    MeasureMap metrics = MeasureMap.builder().put(M3, 9999L).put(M4, 8888L).build();
+    MeasureMapInternal metrics = MeasureMapInternal.builder().put(M3, 9999L).put(M4, 8888L).build();
     assertContains(metrics,
         MeasurementLong.create(M3, 9999L),
         MeasurementLong.create(M4, 8888L));
   }
 
   @Test
   public void testCombination() {
-    MeasureMap metrics =
-        MeasureMap.builder().put(M1, 44.4).put(M2, 66.6).put(M3, 9999L).put(M4, 8888L).build();
+    MeasureMapInternal metrics =
+        MeasureMapInternal.builder().put(M1, 44.4).put(M2, 66.6).put(M3, 9999L).put(M4, 8888L)
+            .build();
     assertContains(metrics,
         MeasurementDouble.create(M1, 44.4),
         MeasurementDouble.create(M2, 66.6),
@@ -61,14 +62,14 @@ public void testCombination() {
 
   @Test
   public void testBuilderEmpty() {
-    MeasureMap metrics = MeasureMap.builder().build();
+    MeasureMapInternal metrics = MeasureMapInternal.builder().build();
     assertContains(metrics);
   }
 
   @Test
   public void testBuilder() {
     ArrayList<Measurement> expected = new ArrayList<Measurement>(10);
-    MeasureMap.Builder builder = MeasureMap.builder();
+    MeasureMapInternal.Builder builder = MeasureMapInternal.builder();
     for (int i = 1; i <= 10; i++) {
       expected
           .add(MeasurementDouble.create(makeSimpleMeasureDouble("m" + i), i * 11.1));
@@ -79,38 +80,38 @@ public void testBuilder() {
 
   @Test
   public void testDuplicateMeasureDoubles() {
-    assertContains(MeasureMap.builder().put(M1, 1.0).put(M1, 2.0).build(),
+    assertContains(MeasureMapInternal.builder().put(M1, 1.0).put(M1, 2.0).build(),
         MeasurementDouble.create(M1, 2.0));
-    assertContains(MeasureMap.builder().put(M1, 1.0).put(M1, 2.0).put(M1, 3.0).build(),
+    assertContains(MeasureMapInternal.builder().put(M1, 1.0).put(M1, 2.0).put(M1, 3.0).build(),
         MeasurementDouble.create(M1, 3.0));
-    assertContains(MeasureMap.builder().put(M1, 1.0).put(M2, 2.0).put(M1, 3.0).build(),
+    assertContains(MeasureMapInternal.builder().put(M1, 1.0).put(M2, 2.0).put(M1, 3.0).build(),
         MeasurementDouble.create(M1, 3.0),
         MeasurementDouble.create(M2, 2.0));
-    assertContains(MeasureMap.builder().put(M1, 1.0).put(M1, 2.0).put(M2, 2.0).build(),
+    assertContains(MeasureMapInternal.builder().put(M1, 1.0).put(M1, 2.0).put(M2, 2.0).build(),
         MeasurementDouble.create(M1, 2.0),
         MeasurementDouble.create(M2, 2.0));
   }
 
   @Test
   public void testDuplicateMeasureLongs() {
-    assertContains(MeasureMap.builder().put(M3, 100L).put(M3, 100L).build(),
+    assertContains(MeasureMapInternal.builder().put(M3, 100L).put(M3, 100L).build(),
         MeasurementLong.create(M3, 100L));
-    assertContains(MeasureMap.builder().put(M3, 100L).put(M3, 200L).put(M3, 300L).build(),
+    assertContains(MeasureMapInternal.builder().put(M3, 100L).put(M3, 200L).put(M3, 300L).build(),
         MeasurementLong.create(M3, 300L));
-    assertContains(MeasureMap.builder().put(M3, 100L).put(M4, 200L).put(M3, 300L).build(),
+    assertContains(MeasureMapInternal.builder().put(M3, 100L).put(M4, 200L).put(M3, 300L).build(),
         MeasurementLong.create(M3, 300L),
         MeasurementLong.create(M4, 200L));
-    assertContains(MeasureMap.builder().put(M3, 100L).put(M3, 200L).put(M4, 200L).build(),
+    assertContains(MeasureMapInternal.builder().put(M3, 100L).put(M3, 200L).put(M4, 200L).build(),
         MeasurementLong.create(M3, 200L),
         MeasurementLong.create(M4, 200L));
   }
 
   @Test
   public void testDuplicateMeasures() {
-    assertContains(MeasureMap.builder().put(M3, 100L).put(M1, 1.0).put(M3, 300L).build(),
+    assertContains(MeasureMapInternal.builder().put(M3, 100L).put(M1, 1.0).put(M3, 300L).build(),
         MeasurementLong.create(M3, 300L),
         MeasurementDouble.create(M1, 1.0));
-    assertContains(MeasureMap.builder().put(M2, 2.0).put(M3, 100L).put(M2, 3.0).build(),
+    assertContains(MeasureMapInternal.builder().put(M2, 2.0).put(M3, 100L).put(M2, 3.0).build(),
         MeasurementDouble.create(M2, 3.0),
         MeasurementLong.create(M3, 100L));
   }
@@ -128,7 +129,7 @@ private static MeasureLong makeSimpleMeasureLong(String measure) {
     return Measure.MeasureLong.create(measure, measure + " description", "1");
   }
 
-  private static void assertContains(MeasureMap metrics, Measurement... measurements) {
+  private static void assertContains(MeasureMapInternal metrics, Measurement... measurements) {
     assertThat(Lists.newArrayList(metrics.iterator())).containsExactly((Object[]) measurements);
   }
 }