Adding getOrDefault methods to TagMap

Author: dougqh

internal-api/src/main/java/datadog/trace/api/TagMap.java

@@ -123,14 +123,24 @@ public static Ledger ledger(int size) {
 
   boolean getBoolean(String tag);
 
+  boolean getBooleanOrDefault(String tag, boolean defaultValue);
+
   int getInt(String tag);
 
+  int getIntOrDefault(String tag, int defaultValue);
+
   long getLong(String tag);
 
+  long getLongOrDefault(String tag, long defaultValue);
+
   float getFloat(String tag);
 
+  float getFloatOrDefault(String tag, float defaultValue);
+
   double getDouble(String tag);
 
+  double getDoubleOrDefault(String tag, double defaultValue);
+
   /**
    * Provides the corresponding Entry object - preferable w/ optimized TagMap if the Entry needs to
    * have its type checked
@@ -1162,26 +1172,46 @@ public final String getString(String tag) {
   }
 
   public final boolean getBoolean(String tag) {
+    return this.getBooleanOrDefault(tag, false);
+  }
+
+  public final boolean getBooleanOrDefault(String tag, boolean defaultValue) {
     Entry entry = this.getEntry(tag);
-    return entry == null ? false : entry.booleanValue();
+    return entry == null ? defaultValue : entry.booleanValue();
   }
 
   public final int getInt(String tag) {
+    return getIntOrDefault(tag, 0);
+  }
+
+  public final int getIntOrDefault(String tag, int defaultValue) {
     Entry entry = this.getEntry(tag);
-    return entry == null ? 0 : entry.intValue();
+    return entry == null ? defaultValue : entry.intValue();
   }
 
   public final long getLong(String tag) {
+    return this.getLongOrDefault(tag, 0L);
+  }
+
+  public final long getLongOrDefault(String tag, long defaultValue) {
     Entry entry = this.getEntry(tag);
-    return entry == null ? 0L : entry.longValue();
+    return entry == null ? defaultValue : entry.longValue();
   }
 
   public final float getFloat(String tag) {
+    return this.getFloatOrDefault(tag, 0F);
+  }
+
+  public final float getFloatOrDefault(String tag, float defaultValue) {
     Entry entry = this.getEntry(tag);
-    return entry == null ? 0F : entry.floatValue();
+    return entry == null ? defaultValue : entry.floatValue();
   }
 
   public final double getDouble(String tag) {
+    return this.getDoubleOrDefault(tag, 0D);
+  }
+
+  public final double getDoubleOrDefault(String tag, double defaultValue) {
     Entry entry = this.getEntry(tag);
     return entry == null ? 0D : entry.doubleValue();
   }
@@ -2641,26 +2671,6 @@ public final <T, U> void forEach(
     }
   }
 
-  @Override
-  public final Object getObject(String tag) {
-    return this.get(tag);
-  }
-
-  @Override
-  public final boolean getBoolean(String tag) {
-    Object result = this.get(tag);
-    if (result == null) return false;
-
-    if (result instanceof Boolean) {
-      return (Boolean) result;
-    } else if (result instanceof Number) {
-      Number number = (Number) result;
-      return (number.intValue() != 0);
-    } else {
-      return true;
-    }
-  }
-
   @Override
   public final TagMap.Entry getAndSet(String tag, Object value) {
     Object prior = this.put(tag, value);
@@ -2710,55 +2720,106 @@ public final TagMap.Entry getAndRemove(String tag) {
   }
 
   @Override
-  public final double getDouble(String tag) {
+  public final Object getObject(String tag) {
+    return this.get(tag);
+  }
+
+  @Override
+  public final boolean getBoolean(String tag) {
+    return this.getBooleanOrDefault(tag, false);
+  }
+
+  @Override
+  public final boolean getBooleanOrDefault(String tag, boolean defaultValue) {
+    Object result = this.get(tag);
+    if (result == null) {
+      return defaultValue;
+    } else if (result instanceof Boolean) {
+      return (Boolean) result;
+    } else if (result instanceof Number) {
+      Number number = (Number) result;
+      return (number.intValue() != 0);
+    } else {
+      // deliberately doesn't use defaultValue
+      return true;
+    }
+  }
+
+  @Override
+  public double getDouble(String tag) {
+    return this.getDoubleOrDefault(tag, 0D);
+  }
+
+  @Override
+  public final double getDoubleOrDefault(String tag, double defaultValue) {
     Object value = this.get(tag);
-    if (value instanceof Number) {
+    if (value == null) {
+      return defaultValue;
+    } else if (value instanceof Number) {
       return ((Number) value).doubleValue();
     } else if (value instanceof Boolean) {
       return ((Boolean) value) ? 1D : 0D;
     } else {
+      // deliberately doesn't use defaultValue
       return 0D;
     }
   }
 
   @Override
   public final long getLong(String tag) {
+    return this.getLongOrDefault(tag, 0L);
+  }
+
+  public final long getLongOrDefault(String tag, long defaultValue) {
     Object value = this.get(tag);
     if (value == null) {
-      return 0L;
+      return defaultValue;
     } else if (value instanceof Number) {
       return ((Number) value).longValue();
     } else if (value instanceof Boolean) {
       return ((Boolean) value) ? 1L : 0L;
     } else {
+      // deliberately doesn't use defaultValue
       return 0L;
     }
   }
 
   @Override
   public final float getFloat(String tag) {
+    return this.getFloatOrDefault(tag, 0F);
+  }
+
+  @Override
+  public final float getFloatOrDefault(String tag, float defaultValue) {
     Object value = this.get(tag);
     if (value == null) {
-      return 0F;
+      return defaultValue;
     } else if (value instanceof Number) {
       return ((Number) value).floatValue();
     } else if (value instanceof Boolean) {
       return ((Boolean) value) ? 1F : 0F;
     } else {
+      // deliberately doesn't use defaultValue
       return 0F;
     }
   }
 
   @Override
   public final int getInt(String tag) {
+    return this.getIntOrDefault(tag, 0);
+  }
+
+  @Override
+  public final int getIntOrDefault(String tag, int defaultValue) {
     Object value = this.get(tag);
     if (value == null) {
-      return 0;
+      return defaultValue;
     } else if (value instanceof Number) {
       return ((Number) value).intValue();
     } else if (value instanceof Boolean) {
       return ((Boolean) value) ? 1 : 0;
     } else {
+      // deliberately doesn't use defaultValue
       return 0;
     }
   }

internal-api/src/test/java/datadog/trace/api/TagMapTest.java

@@ -60,6 +60,9 @@ public void booleanEntry(TagMapType mapType) {
 
     TagMap.Entry newEntry = map.getEntry("bool");
     assertEquals(second, newEntry.booleanValue());
+
+    assertEquals(false, map.getBoolean("unset"));
+    assertEquals(true, map.getBooleanOrDefault("unset", true));
   }
 
   @ParameterizedTest
@@ -87,6 +90,9 @@ public void intEntry(TagMapType mapType) {
 
     TagMap.Entry newEntry = map.getEntry("int");
     assertEquals(second, newEntry.intValue());
+
+    assertEquals(0, map.getInt("unset"));
+    assertEquals(21, map.getIntOrDefault("unset", 21));
   }
 
   @ParameterizedTest
@@ -114,6 +120,9 @@ public void longEntry(TagMapType mapType) {
 
     TagMap.Entry newEntry = map.getEntry("long");
     assertEquals(second, newEntry.longValue());
+
+    assertEquals(0L, map.getLong("unset"));
+    assertEquals(21L, map.getLongOrDefault("unset", 21L));
   }
 
   @ParameterizedTest
@@ -141,6 +150,9 @@ public void floatEntry(TagMapType mapType) {
 
     TagMap.Entry newEntry = map.getEntry("float");
     assertEquals(second, newEntry.floatValue());
+
+    assertEquals(0F, map.getFloat("unset"));
+    assertEquals(2.718F, map.getFloatOrDefault("unset", 2.718F));
   }
 
   @ParameterizedTest
@@ -168,6 +180,9 @@ public void doubleEntry(TagMapType mapType) {
 
     TagMap.Entry newEntry = map.getEntry("double");
     assertEquals(second, newEntry.doubleValue());
+
+    assertEquals(0D, map.getDouble("unset"));
+    assertEquals(2.718D, map.getDoubleOrDefault("unset", 2.718D));
   }
 
   @ParameterizedTest