revamping write method to improve code clearity

dhaval24 · dhaval24 · commit 2722eb9e03ff · 2017-09-22T14:10:14.000-07:00
diff --git a/core/src/main/java/com/microsoft/applicationinsights/internal/schemav2/AvailabilityData.java b/core/src/main/java/com/microsoft/applicationinsights/internal/schemav2/AvailabilityData.java
@@ -232,17 +232,12 @@ protected void serializeContent(JsonTelemetryDataSerializer writer) throws IOExc
     {
         super.serializeContent(writer);
         writer.write("ver", ver);
-        
-        writer.write("id", id, 64, true);
-        
-        writer.write("name", name, 1024, true);
-        
+        writer.writeRequired("id", id, 64);
+        writer.writeRequired("name", name, 1024);
         writer.write("duration", duration);
-        
         writer.write("success", success);
-        
-        writer.write("runLocation", runLocation, 1024, false);
-        writer.write("message", message, 8192, false);
+        writer.write("runLocation", runLocation, 1024);
+        writer.write("message", message, 8192);
         writer.write("properties", properties);
         writer.write("measurements", measurements);
     }
diff --git a/core/src/main/java/com/microsoft/applicationinsights/internal/schemav2/Base.java b/core/src/main/java/com/microsoft/applicationinsights/internal/schemav2/Base.java
@@ -43,29 +43,29 @@ public class Base
      * Backing field for property BaseType.
      */
     private String baseType;
-
+    
     /**
      * Initializes a new instance of the Base class.
      */
     public Base()
     {
         this.InitializeFields();
     }
-
+    
     /**
      * Gets the BaseType property.
      */
     public String getBaseType() {
         return this.baseType;
     }
-
+    
     /**
      * Sets the BaseType property.
      */
     public void setBaseType(String value) {
         this.baseType = value;
     }
-
+    
 
     /**
      * Serializes the beginning of this object to the passed in writer.
@@ -84,13 +84,13 @@ public void serialize(JsonTelemetryDataSerializer writer) throws IOException
      */
     protected void serializeContent(JsonTelemetryDataSerializer writer) throws IOException
     {
-        writer.write("baseType", baseType, 1000, false);
+        writer.writeRequired("baseType", baseType, 1000);
     }
-
+    
     /**
      * Optionally initializes fields for the current context.
      */
     protected void InitializeFields() {
-
+        
     }
 }
diff --git a/core/src/main/java/com/microsoft/applicationinsights/internal/schemav2/DataPoint.java b/core/src/main/java/com/microsoft/applicationinsights/internal/schemav2/DataPoint.java
@@ -198,11 +198,9 @@ public void serialize(JsonTelemetryDataSerializer writer) throws IOException
      */
     protected void serializeContent(JsonTelemetryDataSerializer writer) throws IOException
     {
-        writer.write("name", name, 1024, true);
-        
+        writer.writeRequired("name", name, 1024);
         writer.write("kind", kind);
         writer.write("value", value);
-        
         writer.write("count", count);
         writer.write("min", min);
         writer.write("max", max);
diff --git a/core/src/main/java/com/microsoft/applicationinsights/internal/schemav2/Domain.java b/core/src/main/java/com/microsoft/applicationinsights/internal/schemav2/Domain.java
@@ -32,12 +32,10 @@
 import com.microsoft.applicationinsights.telemetry.Duration;
 import com.microsoft.applicationinsights.telemetry.JsonTelemetryDataSerializer;
 import com.google.common.base.Preconditions;
-import org.apache.http.annotation.Obsolete;
 
 /**
  * Data contract class Domain.
  */
-@Obsolete
 public class Domain
     implements JsonSerializable
 {
diff --git a/core/src/main/java/com/microsoft/applicationinsights/internal/schemav2/Envelope.java b/core/src/main/java/com/microsoft/applicationinsights/internal/schemav2/Envelope.java
@@ -221,14 +221,13 @@ public void serialize(JsonTelemetryDataSerializer writer) throws IOException
     protected void serializeContent(JsonTelemetryDataSerializer writer) throws IOException
     {
         writer.write("ver", ver);
-        writer.write("name", name, 1024, true);
-        
-        writer.write("time", time, 64, true);
-        
-        if (this.sampleRate > 0.0d)
-        writer.write("sampleRate", sampleRate);
-        writer.write("seq", seq, 64, false);
-        writer.write("iKey", iKey, 40, false);
+        writer.writeRequired("name", name, 1024);
+        writer.writeRequired("time", time, 64);
+        if (this.sampleRate > 0.0d) {
+            writer.write("sampleRate", sampleRate);
+        }
+        writer.write("seq", seq, 64);
+        writer.write("iKey", iKey, 40);
         writer.write("tags", tags);
         writer.write("data", data);
     }
diff --git a/core/src/main/java/com/microsoft/applicationinsights/internal/schemav2/EventData.java b/core/src/main/java/com/microsoft/applicationinsights/internal/schemav2/EventData.java
@@ -137,9 +137,7 @@ protected void serializeContent(JsonTelemetryDataSerializer writer) throws IOExc
     {
         super.serializeContent(writer);
         writer.write("ver", ver);
-        
-        writer.write("name", name, 512, true);
-        
+        writer.writeRequired("name", name, 512);
         writer.write("properties", properties);
         writer.write("measurements", measurements);
     }
diff --git a/core/src/main/java/com/microsoft/applicationinsights/internal/schemav2/ExceptionData.java b/core/src/main/java/com/microsoft/applicationinsights/internal/schemav2/ExceptionData.java
@@ -178,11 +178,9 @@ protected void serializeContent(JsonTelemetryDataSerializer writer) throws IOExc
     {
         super.serializeContent(writer);
         writer.write("ver", ver);
-        
         writer.write("exceptions", exceptions);
-        
         writer.write("severityLevel", severityLevel);
-        writer.write("problemId", problemId, 1024, false);
+        writer.write("problemId", problemId, 1024);
         writer.write("properties", properties);
         writer.write("measurements", measurements);
     }
diff --git a/core/src/main/java/com/microsoft/applicationinsights/internal/schemav2/ExceptionDetails.java b/core/src/main/java/com/microsoft/applicationinsights/internal/schemav2/ExceptionDetails.java
@@ -203,12 +203,10 @@ protected void serializeContent(JsonTelemetryDataSerializer writer) throws IOExc
     {
         writer.write("id", id);
         writer.write("outerId", outerId);
-        writer.write("typeName", typeName, 1024, true);
-        
-        writer.write("message", message, 32768, true);
-        
+        writer.writeRequired("typeName", typeName, 1024);
+        writer.writeRequired("message", message, 32768);
         writer.write("hasFullStack", hasFullStack);
-        writer.write("stack", stack, 32768, false);
+        writer.write("stack", stack, 32768);
         writer.write("parsedStack", parsedStack);
     }
     
diff --git a/core/src/main/java/com/microsoft/applicationinsights/internal/schemav2/MessageData.java b/core/src/main/java/com/microsoft/applicationinsights/internal/schemav2/MessageData.java
@@ -134,9 +134,7 @@ protected void serializeContent(JsonTelemetryDataSerializer writer) throws IOExc
     {
         super.serializeContent(writer);
         writer.write("ver", ver);
-        
-        writer.write("message", message, 32768, true);
-        
+        writer.writeRequired("message", message, 32768);
         writer.write("severityLevel", severityLevel);
         writer.write("properties", properties);
     }
diff --git a/core/src/main/java/com/microsoft/applicationinsights/internal/schemav2/PageViewData.java b/core/src/main/java/com/microsoft/applicationinsights/internal/schemav2/PageViewData.java
@@ -92,7 +92,7 @@ public void setDuration(Duration value) {
     protected void serializeContent(JsonTelemetryDataSerializer writer) throws IOException
     {
         super.serializeContent(writer);
-        writer.write("url", url, 2048, false);
+        writer.write("url", url, 2048);
         writer.write("duration", duration);
     }
     
diff --git a/core/src/main/java/com/microsoft/applicationinsights/internal/schemav2/PerformanceCounterData.java b/core/src/main/java/com/microsoft/applicationinsights/internal/schemav2/PerformanceCounterData.java
@@ -98,9 +98,9 @@ protected void serializeContent(JsonTelemetryDataSerializer writer) throws IOExc
         Preconditions.checkNotNull(writer, "writer must be a non-null value");
 
         writer.write("ver", ver);
-        writer.write("categoryName", categoryName, 1000, false);
-        writer.write("counterName", counterName, 1000, false);
-        writer.write("instanceName", instanceName, 1000, false);
+        writer.write("categoryName", categoryName, 1000);
+        writer.write("counterName", counterName, 1000);
+        writer.write("instanceName", instanceName, 1000);
         writer.write("value", value);
         writer.write("properties", properties);
     }
diff --git a/core/src/main/java/com/microsoft/applicationinsights/internal/schemav2/RemoteDependencyData.java b/core/src/main/java/com/microsoft/applicationinsights/internal/schemav2/RemoteDependencyData.java
@@ -270,17 +270,14 @@ protected void serializeContent(JsonTelemetryDataSerializer writer) throws IOExc
     {
         super.serializeContent(writer);
         writer.write("ver", ver);
-        
-        writer.write("name", name, 1024, true);
-        
-        writer.write("id", id, 128, false);
-        writer.write("resultCode", resultCode, 1024, false);
+        writer.writeRequired("name", name, 1024);
+        writer.write("id", id, 128);
+        writer.write("resultCode", resultCode, 1024);
         writer.write("duration", duration);
-        
         writer.write("success", success);
-        writer.write("data", data, 8192, false);
-        writer.write("type", type, 1024, false);
-        writer.write("target", target, 1024, false);
+        writer.write("data", data, 8192);
+        writer.write("type", type, 1024);
+        writer.write("target", target, 1024);
         writer.write("properties", properties);
         writer.write("measurements", measurements);
     }
diff --git a/core/src/main/java/com/microsoft/applicationinsights/internal/schemav2/RequestData.java b/core/src/main/java/com/microsoft/applicationinsights/internal/schemav2/RequestData.java
@@ -251,18 +251,13 @@ protected void serializeContent(JsonTelemetryDataSerializer writer) throws IOExc
     {
         super.serializeContent(writer);
         writer.write("ver", ver);
-        
-        writer.write("id", id, 128, true);
-        
+        writer.writeRequired("id", id, 128);
         writer.write("duration", duration);
-        
-        writer.write("responseCode", responseCode, 1024, true);
-        
+        writer.writeRequired("responseCode", responseCode, 1024);
         writer.write("success", success);
-        
-        writer.write("source", source, 1024, false);
-        writer.write("name", name, 1024, false);
-        writer.write("url", url, 2048, false);
+        writer.write("source", source, 1024);
+        writer.write("name", name, 1024);
+        writer.write("url", url, 2048);
         writer.write("properties", properties);
         writer.write("measurements", measurements);
     }
diff --git a/core/src/main/java/com/microsoft/applicationinsights/internal/schemav2/SessionStateData.java b/core/src/main/java/com/microsoft/applicationinsights/internal/schemav2/SessionStateData.java
@@ -63,6 +63,6 @@ protected void serializeContent(JsonTelemetryDataSerializer writer) throws IOExc
         Preconditions.checkNotNull(writer, "writer must be a non-null value");
 
         writer.write("ver", ver);
-        writer.write("state", state.toString(), 1000, false);
+        writer.write("state", state.toString(), 1000);
     }
 }
diff --git a/core/src/main/java/com/microsoft/applicationinsights/internal/schemav2/StackFrame.java b/core/src/main/java/com/microsoft/applicationinsights/internal/schemav2/StackFrame.java
@@ -162,10 +162,10 @@ protected void serializeContent(JsonTelemetryDataSerializer writer) throws IOExc
     {
         writer.write("level", level);
         
-        writer.write("method", method, 1024, true);
+        writer.writeRequired("method", method, 1024);
         
-        writer.write("assembly", assembly, 1024, false);
-        writer.write("fileName", fileName, 1024, false);
+        writer.write("assembly", assembly, 1024);
+        writer.write("fileName", fileName, 1024);
         writer.write("line", line);
     }
     
diff --git a/core/src/main/java/com/microsoft/applicationinsights/telemetry/JsonTelemetryDataSerializer.java b/core/src/main/java/com/microsoft/applicationinsights/telemetry/JsonTelemetryDataSerializer.java
@@ -193,15 +193,22 @@ public void write(String name, String value) throws IOException {
         //obsolete classes in next major release
     }
 
-    public void write(String name, String value, int len, boolean isReq) throws IOException {
-        if (value == null && !isReq) {
+    public void write(String name, String value, int len) throws IOException {
+        if (value == null) {
             return;
         }
+        writeToJson(name, value, len);
+    }
 
+    public void writeRequired(String name, String value, int len) throws IOException{
         //If field is required and not present set default value
-        if (value == null && isReq) {
+        if (value == null) {
             value = "DEFAULT " + name;
         }
+        writeToJson(name, value, len);
+    }
+
+    private void writeToJson(String name, String value, int len) throws IOException {
 
         writeName(name);
         out.write(JSON_COMMA);
diff --git a/core/src/test/java/com/microsoft/applicationinsights/internal/channel/common/GzipTelemetrySerializerTest.java b/core/src/test/java/com/microsoft/applicationinsights/internal/channel/common/GzipTelemetrySerializerTest.java
@@ -114,7 +114,7 @@ public String getTelemetryName() {
         @Override
         public void serialize(JsonTelemetryDataSerializer writer) throws IOException {
             writer.write("ver", 1);
-            writer.write("telemetryName", telemetryName, 150, true);
+            writer.writeRequired("telemetryName", telemetryName, 150);
             writer.write("properties", this.getProperties());
         }
 
diff --git a/core/src/test/java/com/microsoft/applicationinsights/telemetry/JsonTelemetryDataSerializerTest.java b/core/src/test/java/com/microsoft/applicationinsights/telemetry/JsonTelemetryDataSerializerTest.java
@@ -43,8 +43,8 @@ private final static class TestClassWithStrings implements JsonSerializable, Ser
 
         @Override
         public void serialize(JsonTelemetryDataSerializer serializer) throws IOException {
-            serializer.write("s1", s1, 100, true);
-            serializer.write("s2", s2, 15, false);
+            serializer.writeRequired("s1", s1, 100);
+            serializer.write("s2", s2, 15);
         }
 
         public String getS1() {
@@ -156,10 +156,10 @@ public void setList1(List<String> list1) {
         public void serialize(JsonTelemetryDataSerializer serializer) throws IOException {
             serializer.write("i1", i1);
             serializer.write("i2", i2);
-            serializer.write("s1", s1, 10, true);
+            serializer.writeRequired("s1", s1, 10);
             serializer.write("l1", l1);
             serializer.write("l2", l2);
-            serializer.write("s2", s2, 15, false);
+            serializer.write("s2", s2, 15);
             serializer.write("m1", m1);
             serializer.write("list1", list1);
         }

Original file line number	Diff line number	Diff line change
`@@ -137,9 +137,7 @@ protected void serializeContent(JsonTelemetryDataSerializer writer) throws IOExc`
`137`	`137`	`{`
`138`	`138`	`super.serializeContent(writer);`
`139`	`139`	`writer.write("ver", ver);`
`140`		`-`
`141`		`- writer.write("name", name, 512, true);`
`142`		`-`
	`140`	`+ writer.writeRequired("name", name, 512);`
`143`	`141`	`writer.write("properties", properties);`
`144`	`142`	`writer.write("measurements", measurements);`
`145`	`143`	`}`
Original file line number	Diff line number	Diff line change
`@@ -178,11 +178,9 @@ protected void serializeContent(JsonTelemetryDataSerializer writer) throws IOExc`
`178`	`178`	`{`
`179`	`179`	`super.serializeContent(writer);`
`180`	`180`	`writer.write("ver", ver);`
`181`		`-`
`182`	`181`	`writer.write("exceptions", exceptions);`
`183`		`-`
`184`	`182`	`writer.write("severityLevel", severityLevel);`
`185`		`- writer.write("problemId", problemId, 1024, false);`
	`183`	`+ writer.write("problemId", problemId, 1024);`
`186`	`184`	`writer.write("properties", properties);`
`187`	`185`	`writer.write("measurements", measurements);`
`188`	`186`	`}`
Original file line number	Diff line number	Diff line change
`@@ -134,9 +134,7 @@ protected void serializeContent(JsonTelemetryDataSerializer writer) throws IOExc`
`134`	`134`	`{`
`135`	`135`	`super.serializeContent(writer);`
`136`	`136`	`writer.write("ver", ver);`
`137`		`-`
`138`		`- writer.write("message", message, 32768, true);`
`139`		`-`
	`137`	`+ writer.writeRequired("message", message, 32768);`
`140`	`138`	`writer.write("severityLevel", severityLevel);`
`141`	`139`	`writer.write("properties", properties);`
`142`	`140`	`}`
Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,7 @@ public void setDuration(Duration value) {`
`92`	`92`	`protected void serializeContent(JsonTelemetryDataSerializer writer) throws IOException`
`93`	`93`	`{`
`94`	`94`	`super.serializeContent(writer);`
`95`		`- writer.write("url", url, 2048, false);`
	`95`	`+ writer.write("url", url, 2048);`
`96`	`96`	`writer.write("duration", duration);`
`97`	`97`	`}`
`98`	`98`