refactored to use metric parameters

Author: lksfrnz

src/main/java/software/amazon/cloudwatchlogs/emf/model/Metric.java

@@ -16,6 +16,7 @@
 
 package software.amazon.cloudwatchlogs.emf.model;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
@@ -31,7 +32,7 @@
 
 /** Abstract immutable (except for name) class that all Metrics are based on. */
 @Getter
-public abstract class Metric {
+public abstract class Metric<V> {
     @JsonProperty("Name")
     @Setter(AccessLevel.PROTECTED)
     @NonNull
@@ -50,8 +51,7 @@ public abstract class Metric {
     @JsonSerialize(using = StorageResolutionSerializer.class)
     protected StorageResolution storageResolution;
 
-    /** @return the values stored by this metric. */
-    abstract Object getValues();
+    @JsonIgnore @Getter protected V values;
 
     /** @return the values of this metric formatted to be flushed */
     protected Object getFormattedValues() {
@@ -76,20 +76,49 @@ protected Object getFormattedValues() {
      */
     protected abstract Metric getMetricValuesOverSize(int size);
 
-    public static interface MetricBuilder {
+    public abstract static class MetricBuilder<V, T extends MetricBuilder<V, T>> extends Metric<V> {
+
+        protected abstract T getThis();
 
         /**
          * Adds a value to the metric.
          *
          * @param value the value to be added to this metric
          */
-        MetricBuilder addValue(double value);
+        abstract T addValue(double value);
 
         /**
          * Builds the metric.
          *
          * @return the built metric
          */
-        Metric build();
+        abstract Metric build();
+
+        protected T name(@NonNull String name) {
+            this.name = name;
+            return getThis();
+        }
+
+        public T unit(Unit unit) {
+            this.unit = unit;
+            return getThis();
+        }
+
+        public T storageResolution(StorageResolution storageResolution) {
+            this.storageResolution = storageResolution;
+            return getThis();
+        }
+
+        protected Metric getMetricValuesOverSize(int size) {
+            return build().getMetricValuesOverSize(size);
+        }
+
+        protected Metric getMetricValuesUnderSize(int size) {
+            return build().getMetricValuesUnderSize(size);
+        }
+
+        protected Object getFormattedValues() {
+            return build().getFormattedValues();
+        }
     }
 }

src/main/java/software/amazon/cloudwatchlogs/emf/model/MetricDefinition.java

@@ -16,15 +16,12 @@
 
 package software.amazon.cloudwatchlogs.emf.model;
 
-import com.fasterxml.jackson.annotation.JsonIgnore;
 import java.util.ArrayList;
 import java.util.List;
-import lombok.Getter;
 import lombok.NonNull;
 
 /** Represents the MetricDefinition of the EMF schema. */
-public class MetricDefinition extends Metric {
-    @JsonIgnore @Getter protected List<Double> values;
+public class MetricDefinition extends Metric<List<Double>> {
 
     private MetricDefinition(
             @NonNull String name,
@@ -85,30 +82,21 @@ protected Object getFormattedValues() {
         return values.size() == 1 ? values.get(0) : values;
     }
 
-    public static class MetricDefinitionBuilder extends MetricDefinition
-            implements Metric.MetricBuilder {
-        public MetricDefinitionBuilder() {
-            super(Unit.NONE, StorageResolution.STANDARD, new ArrayList<>());
-        }
-
-        protected MetricDefinitionBuilder name(@NonNull String name) {
-            this.name = name;
-            return this;
-        }
+    public static class MetricDefinitionBuilder
+            extends Metric.MetricBuilder<List<Double>, MetricDefinitionBuilder> {
 
         @Override
-        public MetricDefinitionBuilder addValue(double value) {
-            this.values.add(value);
+        protected MetricDefinitionBuilder getThis() {
             return this;
         }
 
-        public MetricDefinitionBuilder unit(Unit unit) {
-            this.unit = unit;
-            return this;
+        public MetricDefinitionBuilder() {
+            this.values = new ArrayList<>();
         }
 
-        public MetricDefinitionBuilder storageResolution(StorageResolution storageResolution) {
-            this.storageResolution = storageResolution;
+        @Override
+        public MetricDefinitionBuilder addValue(double value) {
+            this.values.add(value);
             return this;
         }
 

src/test/java/software/amazon/cloudwatchlogs/emf/model/MetricDefinitionTest.java

@@ -28,7 +28,7 @@ class MetricDefinitionTest {
 
     @Test(expected = NullPointerException.class)
     public void testThrowExceptionIfNameIsNull() {
-        MetricDefinition builder = MetricDefinition.builder();
+        MetricDefinition.MetricDefinitionBuilder builder = MetricDefinition.builder();
         builder.setName(null);
     }
 
@@ -80,7 +80,7 @@ public void testSerializeMetricDefinitionWithoutUnitWithStandardStorageResolutio
     @Test
     public void testSerializeMetricDefinitionWithoutUnit() throws JsonProcessingException {
         ObjectMapper objectMapper = new ObjectMapper();
-        MetricDefinition metricDefinition = MetricDefinition.builder().name("Time");
+        MetricDefinition metricDefinition = MetricDefinition.builder().name("Time").build();
         String metricString = objectMapper.writeValueAsString(metricDefinition);
 
         assertEquals("{\"Name\":\"Time\",\"Unit\":\"None\"}", metricString);

src/test/java/software/amazon/cloudwatchlogs/emf/model/MetricDirectiveTest.java

@@ -71,7 +71,10 @@ void testPutSameMetricMultipleTimes() {
         metricDirective.putMetric("Time", 20);
 
         Assertions.assertEquals(1, metricDirective.getAllMetrics().size());
-        MetricDefinition[] mds = metricDirective.getAllMetrics().toArray(new MetricDefinition[0]);
+        MetricDefinition.MetricDefinitionBuilder[] mds =
+                metricDirective
+                        .getAllMetrics()
+                        .toArray(new MetricDefinition.MetricDefinitionBuilder[0]);
         Assertions.assertEquals(Arrays.asList(10d, 20d), mds[0].getValues());
     }
 

src/test/java/software/amazon/cloudwatchlogs/emf/model/MetricDirectiveThreadSafetyTest.java

@@ -3,6 +3,7 @@
 import static org.junit.Assert.assertEquals;
 
 import java.util.Collections;
+import java.util.List;
 import org.junit.After;
 import org.junit.Test;
 
@@ -50,8 +51,7 @@ public void testConcurrentPutMetricWithDifferentKey() throws InterruptedExceptio
         assertEquals(metricDirective.getAllMetrics().size(), N_THREAD * N_PUT_METRIC);
         for (int i = 0; i < N_THREAD * N_PUT_METRIC; i++) {
             assertEquals(
-                    ((MetricDefinition) metricDirective.getMetrics().get("Metric-" + i))
-                            .getValues()
+                    ((List<Double>) metricDirective.getMetrics().get("Metric-" + i).getValues())
                             .get(0),
                     i,
                     1e-5);
@@ -90,10 +90,11 @@ public void testConcurrentPutMetricWithSameKey() throws InterruptedException {
         }
 
         assertEquals(1, metricDirective.getAllMetrics().size());
-        MetricDefinition md = metricDirective.getAllMetrics().toArray(new MetricDefinition[0])[0];
-        Collections.sort(md.getValues());
+        Metric md = metricDirective.getAllMetrics().toArray(new Metric[0])[0];
+        List<Double> values = (List<Double>) md.getValues();
+        Collections.sort(values);
         for (int i = 0; i < N_THREAD * N_PUT_METRIC; i++) {
-            assertEquals(md.getValues().get(i), i, 1e-5);
+            assertEquals(values.get(i), i, 1e-5);
         }
     }
 

src/test/java/software/amazon/cloudwatchlogs/emf/model/MetricsContextTest.java

@@ -48,9 +48,8 @@ void testSerializeLessThan100Metrics() throws JsonProcessingException, InvalidMe
 
         List<MetricDefinition> metrics = parseMetrics(events.get(0));
         Assertions.assertEquals(metrics.size(), metricCount);
-        for (MetricDefinition metric : metrics) {
-            MetricDefinition originalMetric =
-                    (MetricDefinition) (mc.getRootNode().metrics().get(metric.getName()));
+        for (Metric metric : metrics) {
+            Metric originalMetric = mc.getRootNode().metrics().get(metric.getName());
             Assertions.assertEquals(originalMetric.getName(), metric.getName());
             Assertions.assertEquals(originalMetric.getUnit(), metric.getUnit());
         }
@@ -74,9 +73,9 @@ void testSerializeMoreThen100Metrics() throws JsonProcessingException, InvalidMe
             allMetrics.addAll(parseMetrics(event));
         }
         Assertions.assertEquals(metricCount, allMetrics.size());
-        for (MetricDefinition metric : allMetrics) {
-            MetricDefinition originalMetric =
-                    (MetricDefinition) (mc.getRootNode().metrics().get(metric.getName()));
+        for (Metric metric : allMetrics) {
+            Metric originalMetric = mc.getRootNode().metrics().get(metric.getName());
+
             Assertions.assertEquals(originalMetric.getName(), metric.getName());
             Assertions.assertEquals(originalMetric.getUnit(), metric.getUnit());
         }