Changing TagMap.Builder -> TagMap.Ledger

Renamed TagMap.Builder -> TagMap.Ledger to make the concept a bit more clear

Also renamed Builder.put methods to Ledger.set to be more consistent with TagMap

Update users of TagMap.Builder as needed

Author: dougqh

dd-trace-core/src/main/java/datadog/trace/core/CoreTracer.java

@@ -1380,7 +1380,7 @@ public static class CoreSpanBuilder implements AgentTracer.SpanBuilder {
     private final CoreTracer tracer;
 
     // Builder attributes
-    private TagMap.Builder tagBuilder;
+    private TagMap.Ledger tagLedger;
     private long timestampMicro;
     private AgentSpanContext parent;
     private String serviceName;
@@ -1513,21 +1513,21 @@ public CoreSpanBuilder withTag(final String tag, final Object value) {
       if (tag == null) {
         return this;
       }
-      TagMap.Builder tagBuilder = this.tagBuilder;
-      if (tagBuilder == null) {
+      TagMap.Ledger tagLedger = this.tagLedger;
+      if (tagLedger == null) {
         // Insertion order is important, so using TagBuilder which builds up a set
         // of Entry modifications in order
-        this.tagBuilder = tagBuilder = TagMap.builder();
+        this.tagLedger = tagLedger = TagMap.ledger();
       }
       if (value == null) {
         // DQH - Use of smartRemove is important to avoid clobbering entries added by another map
         // smartRemove only records the removal if a prior matching put has already occurred in the
         // builder
         // smartRemove is O(n) but since removes are rare, this is preferable to a more complicated
         // implementation in setAll
-        tagBuilder.smartRemove(tag);
+        tagLedger.smartRemove(tag);
       } else {
-        tagBuilder.put(tag, value);
+        tagLedger.set(tag, value);
       }
       return this;
     }
@@ -1815,7 +1815,7 @@ private DDSpanContext buildSpanContext() {
       // the builder. This is the order that the tags were added previously, but maybe the `tags`
       // set in the builder should come last, so that they override other tags.
       context.setAllTags(mergedTracerTags, mergedTracerTagsNeedsIntercept);
-      context.setAllTags(tagBuilder);
+      context.setAllTags(tagLedger);
       context.setAllTags(coreTags, coreTagsNeedsIntercept);
       context.setAllTags(rootSpanTags, rootSpanTagsNeedsIntercept);
       context.setAllTags(contextualTags);

dd-trace-core/src/main/java/datadog/trace/core/DDSpanContext.java

@@ -779,14 +779,14 @@ void setAllTags(final TagMap map, boolean needsIntercept) {
     }
   }
 
-  void setAllTags(final TagMap.Builder builder) {
-    if (builder == null) {
+  void setAllTags(final TagMap.Ledger ledger) {
+    if (ledger == null) {
       return;
     }
 
     TagInterceptor tagInterceptor = traceCollector.getTracer().getTagInterceptor();
     synchronized (unsafeTags) {
-      for (final TagMap.EntryChange entryChange : builder) {
+      for (final TagMap.EntryChange entryChange : ledger) {
         if (entryChange.isRemoval()) {
           unsafeTags.removeEntry(entryChange.tag());
         } else {

dd-trace-core/src/main/java/datadog/trace/core/propagation/B3HttpCodec.java

@@ -185,7 +185,7 @@ public B3BaseContextInterpreter(Config config) {
 
     protected void setSpanId(final String sId) {
       spanId = DDSpanId.fromHex(sId);
-      tagBuilder().put(B3_SPAN_ID, sId);
+      tagLedger().set(B3_SPAN_ID, sId);
     }
 
     protected boolean setTraceId(final String tId) {
@@ -198,7 +198,7 @@ protected boolean setTraceId(final String tId) {
         B3TraceId b3TraceId = B3TraceId.fromHex(tId);
         traceId = b3TraceId.toLong() == 0 ? DDTraceId.ZERO : b3TraceId;
       }
-      tagBuilder().put(B3_TRACE_ID, tId);
+      tagLedger().set(B3_TRACE_ID, tId);
       return true;
     }
   }

dd-trace-core/src/main/java/datadog/trace/core/propagation/ContextInterpreter.java

@@ -45,7 +45,7 @@ public abstract class ContextInterpreter implements AgentPropagation.KeyClassifi
   protected DDTraceId traceId;
   protected long spanId;
   protected int samplingPriority;
-  protected TagMap.Builder tagBuilder;
+  protected TagMap.Ledger tagLedger;
   protected Map<String, String> baggage;
 
   protected CharSequence lastParentId;
@@ -78,11 +78,11 @@ protected ContextInterpreter(Config config) {
     this.requestHeaderTagsCommaAllowed = config.isRequestHeaderTagsCommaAllowed();
   }
 
-  final TagMap.Builder tagBuilder() {
-    if (tagBuilder == null) {
-      tagBuilder = TagMap.builder();
+  final TagMap.Ledger tagLedger() {
+    if (tagLedger == null) {
+      tagLedger = TagMap.ledger();
     }
-    return tagBuilder;
+    return tagLedger;
   }
 
   /**
@@ -197,8 +197,8 @@ protected final boolean handleTags(String key, String value) {
     final String lowerCaseKey = toLowerCase(key);
     final String mappedKey = headerTags.get(lowerCaseKey);
     if (null != mappedKey) {
-      tagBuilder()
-          .put(
+      tagLedger()
+          .set(
               mappedKey,
               HttpCodec.decode(
                   requestHeaderTagsCommaAllowed ? value : HttpCodec.firstHeaderValue(value)));
@@ -230,7 +230,7 @@ public ContextInterpreter reset(TraceConfig traceConfig) {
     samplingPriority = PrioritySampling.UNSET;
     origin = null;
     endToEndStartTime = 0;
-    if (tagBuilder != null) tagBuilder.reset();
+    if (tagLedger != null) tagLedger.reset();
     baggage = Collections.emptyMap();
     valid = true;
     fullContext = true;
@@ -258,19 +258,19 @@ protected TagContext build() {
             origin,
             endToEndStartTime,
             baggage,
-            tagBuilder == null ? null : tagBuilder.build(),
+            tagLedger == null ? null : tagLedger.build(),
             httpHeaders,
             propagationTags,
             traceConfig,
             style());
       } else if (origin != null
-          || (tagBuilder != null && !tagBuilder.isDefinitelyEmpty())
+          || (tagLedger != null && !tagLedger.isDefinitelyEmpty())
           || httpHeaders != null
           || !baggage.isEmpty()
           || samplingPriority != PrioritySampling.UNSET) {
         return new TagContext(
             origin,
-            tagBuilder == null ? null : tagBuilder.build(),
+            tagLedger == null ? null : tagLedger.build(),
             httpHeaders,
             baggage,
             samplingPriorityOrDefault(traceId, samplingPriority),

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

@@ -20,7 +20,7 @@
  *
  * <ul>
  *   <li>fast copy from one map to another
- *   <li>compatibility with Builder idioms
+ *   <li>compatibility with builder idioms
  *   <li>building small maps as fast as possible
  *   <li>storing primitives without boxing
  *   <li>minimal memory footprint
@@ -71,14 +71,14 @@ private static final TagMap createEmpty() {
     return new TagMap(new Object[1], 0);
   }
 
-  /** Creates a new TagMap.Builder */
-  public static final Builder builder() {
-    return new Builder();
+  /** Creates a new TagMap.Ledger */
+  public static final Ledger ledger() {
+    return new Ledger();
   }
 
-  /** Creates a new TagMap.Builder which handles <code>size</code> modifications before expansion */
-  public static final Builder builder(int size) {
-    return new Builder(size);
+  /** Creates a new TagMap.Ledger which handles <code>size</code> modifications before expansion */
+  public static final Ledger ledger(int size) {
+    return new Ledger(size);
   }
 
   /** Creates a new mutable TagMap that contains the contents of <code>map</code> */
@@ -337,8 +337,8 @@ public final void putAll(Iterable<? extends Entry> entries) {
     }
   }
 
-  public final void putAll(TagMap.Builder builder) {
-    putAll(builder.entryChanges, builder.nextPos);
+  public final void putAll(TagMap.Ledger ledger) {
+    putAll(ledger.entryChanges, ledger.nextPos);
   }
 
   private final void putAll(EntryChange[] entryChanges, int size) {
@@ -830,19 +830,19 @@ public final String toString() {
   final String toPrettyString() {
     boolean first = true;
 
-    StringBuilder builder = new StringBuilder(128);
-    builder.append('{');
+    StringBuilder ledger = new StringBuilder(128);
+    ledger.append('{');
     for (Entry entry : this) {
       if (first) {
         first = false;
       } else {
-        builder.append(", ");
+        ledger.append(", ");
       }
 
-      builder.append(entry.tag).append('=').append(entry.stringValue());
+      ledger.append(entry.tag).append('=').append(entry.stringValue());
     }
-    builder.append('}');
-    return builder.toString();
+    ledger.append('}');
+    return ledger.toString();
   }
 
   /**
@@ -852,25 +852,25 @@ final String toPrettyString() {
   final String toInternalString() {
     Object[] thisBuckets = this.buckets;
 
-    StringBuilder builder = new StringBuilder(128);
+    StringBuilder ledger = new StringBuilder(128);
     for (int i = 0; i < thisBuckets.length; ++i) {
-      builder.append('[').append(i).append("] = ");
+      ledger.append('[').append(i).append("] = ");
 
       Object thisBucket = thisBuckets[i];
       if (thisBucket == null) {
-        builder.append("null");
+        ledger.append("null");
       } else if (thisBucket instanceof Entry) {
-        builder.append('{').append(thisBucket).append('}');
+        ledger.append('{').append(thisBucket).append('}');
       } else if (thisBucket instanceof BucketGroup) {
         for (BucketGroup curGroup = (BucketGroup) thisBucket;
             curGroup != null;
             curGroup = curGroup.prev) {
-          builder.append(curGroup).append(" -> ");
+          ledger.append(curGroup).append(" -> ");
         }
       }
-      builder.append('\n');
+      ledger.append('\n');
     }
-    return builder.toString();
+    return ledger.toString();
   }
 
   static final int _hash(String tag) {
@@ -1439,16 +1439,20 @@ private static final double prim2Double(long prim) {
     }
   }
 
-  public static final class Builder implements Iterable<EntryChange> {
+  /*
+   * An in-order ledger of changes to be made to a TagMap.
+   * Ledger can also serves as a builder for TagMap-s via build & buildImmutable.
+   */
+  public static final class Ledger implements Iterable<EntryChange> {
     private EntryChange[] entryChanges;
     private int nextPos = 0;
     private boolean containsRemovals = false;
 
-    private Builder() {
+    private Ledger() {
       this(8);
     }
 
-    private Builder(int size) {
+    private Ledger(int size) {
       this.entryChanges = new EntryChange[size];
     }
 
@@ -1457,7 +1461,7 @@ public final boolean isDefinitelyEmpty() {
     }
 
     /**
-     * Provides the estimated size of the map created by the builder Doesn't account for overwritten
+     * Provides the estimated size of the map created by the ledger Doesn't account for overwritten
      * entries or entry removal
      *
      * @return
@@ -1470,54 +1474,48 @@ public final boolean containsRemovals() {
       return this.containsRemovals;
     }
 
-    public final Builder put(String tag, Object value) {
+    public final Ledger set(String tag, Object value) {
       return this.recordEntry(Entry.newAnyEntry(tag, value));
     }
 
-    public final Builder put(String tag, CharSequence value) {
+    public final Ledger set(String tag, CharSequence value) {
       return this.recordEntry(Entry.newObjectEntry(tag, value));
     }
 
-    public final Builder put(String tag, boolean value) {
+    public final Ledger set(String tag, boolean value) {
       return this.recordEntry(Entry.newBooleanEntry(tag, value));
     }
 
-    public final Builder put(String tag, int value) {
+    public final Ledger set(String tag, int value) {
       return this.recordEntry(Entry.newIntEntry(tag, value));
     }
 
-    public final Builder put(String tag, long value) {
+    public final Ledger set(String tag, long value) {
       return this.recordEntry(Entry.newLongEntry(tag, value));
     }
 
-    public final Builder put(String tag, float value) {
+    public final Ledger set(String tag, float value) {
       return this.recordEntry(Entry.newFloatEntry(tag, value));
     }
 
-    public final Builder put(String tag, double value) {
+    public final Ledger set(String tag, double value) {
       return this.recordEntry(Entry.newDoubleEntry(tag, value));
     }
 
-    public final Builder uncheckedPut(Entry entry) {
+    public final Ledger set(Entry entry) {
       return this.recordEntry(entry);
     }
 
-    public final Builder put(Entry entry) {
-      this.recordChange(entry);
-      this.containsRemovals |= entry.isRemoval();
-      return this;
-    }
-
-    public final Builder remove(String tag) {
+    public final Ledger remove(String tag) {
       return this.recordRemoval(EntryChange.newRemoval(tag));
     }
 
-    private final Builder recordEntry(Entry entry) {
+    private final Ledger recordEntry(Entry entry) {
       this.recordChange(entry);
       return this;
     }
 
-    private final Builder recordRemoval(EntryRemoval entry) {
+    private final Ledger recordRemoval(EntryRemoval entry) {
       this.recordChange(entry);
       this.containsRemovals = true;
 
@@ -1532,7 +1530,7 @@ private final void recordChange(EntryChange entryChange) {
       this.entryChanges[this.nextPos++] = entryChange;
     }
 
-    public final Builder smartRemove(String tag) {
+    public final Ledger smartRemove(String tag) {
       if (this.contains(tag)) {
         this.remove(tag);
       }
@@ -2153,15 +2151,15 @@ BucketGroup _cloneEntries() {
 
     @Override
     public String toString() {
-      StringBuilder builder = new StringBuilder(32);
-      builder.append('[');
+      StringBuilder ledger = new StringBuilder(32);
+      ledger.append('[');
       for (int i = 0; i < BucketGroup.LEN; ++i) {
-        if (i != 0) builder.append(", ");
+        if (i != 0) ledger.append(", ");
 
-        builder.append(this._entryAt(i));
+        ledger.append(this._entryAt(i));
       }
-      builder.append(']');
-      return builder.toString();
+      ledger.append(']');
+      return ledger.toString();
     }
   }