Use directly INSTANCE instead of getInstance for BlankSpan. This is more common usage.

5 files changed, 29 insertions, 33 deletions

diff --git a/core/src/main/java/com/google/instrumentation/trace/BlankSpan.java b/core/src/main/java/com/google/instrumentation/trace/BlankSpan.java
index 7088f268..bbe31df2 100644
--- a/core/src/main/java/com/google/instrumentation/trace/BlankSpan.java
+++ b/core/src/main/java/com/google/instrumentation/trace/BlankSpan.java
@@ -13,23 +13,20 @@
 
 package com.google.instrumentation.trace;
 
+import javax.annotation.concurrent.Immutable;
+
 /**
  * The {@code BlankSpan} is a singleton class, which is the default {@link Span} that is used when
  * no {@code Span} implementation is available. All operations are no-op.
  *
  * <p>Used also to stop tracing, see {@link Tracer#withSpan}.
  */
+@Immutable
 public final class BlankSpan extends Span {
-  private static final BlankSpan INSTANCE = new BlankSpan();
-
   /**
-   * Returns the instance of this class.
-   *
-   * @return the instance of this class.
+   * Singleton instance of this class.
    */
-  public static BlankSpan getInstance() {
-    return INSTANCE;
-  }
+  public static final BlankSpan INSTANCE = new BlankSpan();
 
   private BlankSpan() {
     super(SpanContext.getInvalid(), null);
diff --git a/core/src/main/java/com/google/instrumentation/trace/Tracer.java b/core/src/main/java/com/google/instrumentation/trace/Tracer.java
index 6e789e97..a7dbab5f 100644
--- a/core/src/main/java/com/google/instrumentation/trace/Tracer.java
+++ b/core/src/main/java/com/google/instrumentation/trace/Tracer.java
@@ -95,7 +95,7 @@ public final class Tracer {
    */
   public Span getCurrentSpan() {
     Span currentSpan = contextSpanHandler.getCurrentSpan();
-    return currentSpan != null ? currentSpan : BlankSpan.getInstance();
+    return currentSpan != null ? currentSpan : BlankSpan.INSTANCE;
   }
 
   // TODO(bdrutu): Add error_prone annotation @MustBeClosed when the 2.0.16 jar is fixed.
@@ -377,13 +377,13 @@ public final class Tracer {
 
     @Override
     public Span startSpan(@Nullable Span parent, String name, StartSpanOptions options) {
-      return BlankSpan.getInstance();
+      return BlankSpan.INSTANCE;
     }
 
     @Override
     public Span startSpanWithRemoteParent(
         @Nullable SpanContext remoteParent, String name, StartSpanOptions options) {
-      return BlankSpan.getInstance();
+      return BlankSpan.INSTANCE;
     }
   }
 
diff --git a/core/src/test/java/com/google/instrumentation/trace/BlankSpanTest.java b/core/src/test/java/com/google/instrumentation/trace/BlankSpanTest.java
index 57bba9f5..72d48f7e 100644
--- a/core/src/test/java/com/google/instrumentation/trace/BlankSpanTest.java
+++ b/core/src/test/java/com/google/instrumentation/trace/BlankSpanTest.java
@@ -24,27 +24,27 @@ import org.junit.runners.JUnit4;
 public class BlankSpanTest {
   @Test
   public void hasInvalidContextAndDefaultSpanOptions() {
-    assertThat(BlankSpan.getInstance().getContext()).isEqualTo(SpanContext.getInvalid());
-    assertThat(BlankSpan.getInstance().getOptions().isEmpty()).isTrue();
+    assertThat(BlankSpan.INSTANCE.getContext()).isEqualTo(SpanContext.getInvalid());
+    assertThat(BlankSpan.INSTANCE.getOptions().isEmpty()).isTrue();
   }
 
   @Test
   public void doNotCrash() {
     // Tests only that all the methods are not crashing/throwing errors.
-    BlankSpan.getInstance()
+    BlankSpan.INSTANCE
         .addLabels(Labels.builder().putStringLabel("MyLabelKey", "MyLabelValue").build());
-    BlankSpan.getInstance().addAnnotation("MyAnnotation");
-    BlankSpan.getInstance()
+    BlankSpan.INSTANCE.addAnnotation("MyAnnotation");
+    BlankSpan.INSTANCE
         .addAnnotation(
             "MyAnnotation", Labels.builder().putStringLabel("MyLabelKey", "MyLabelValue").build());
-    BlankSpan.getInstance()
+    BlankSpan.INSTANCE
         .addNetworkEvent(NetworkEvent.builder(NetworkEvent.Type.SENT, 1L).build());
-    BlankSpan.getInstance().addChildLink(BlankSpan.getInstance());
-    BlankSpan.getInstance().end(EndSpanOptions.getDefault());
+    BlankSpan.INSTANCE.addChildLink(BlankSpan.INSTANCE);
+    BlankSpan.INSTANCE.end(EndSpanOptions.getDefault());
   }
 
   @Test
   public void blankSpan_ToString() {
-    assertThat(BlankSpan.getInstance().toString()).isEqualTo("BlankSpan");
+    assertThat(BlankSpan.INSTANCE.toString()).isEqualTo("BlankSpan");
   }
 }
diff --git a/core/src/test/java/com/google/instrumentation/trace/StartSpanOptionsTest.java b/core/src/test/java/com/google/instrumentation/trace/StartSpanOptionsTest.java
index 735de7ec..4aa6a243 100644
--- a/core/src/test/java/com/google/instrumentation/trace/StartSpanOptionsTest.java
+++ b/core/src/test/java/com/google/instrumentation/trace/StartSpanOptionsTest.java
@@ -26,9 +26,8 @@ import org.junit.runners.JUnit4;
 /** Unit tests for {@link StartSpanOptions}. */
 @RunWith(JUnit4.class)
 public class StartSpanOptionsTest {
-  private final Span singleParent = BlankSpan.getInstance();
-  private final List<Span> parentList =
-      Arrays.asList(BlankSpan.getInstance(), BlankSpan.getInstance());
+  private final Span singleParent = BlankSpan.INSTANCE;
+  private final List<Span> parentList = Arrays.asList(BlankSpan.INSTANCE, BlankSpan.INSTANCE);
 
   @Test
   public void defaultOptions() {
diff --git a/core/src/test/java/com/google/instrumentation/trace/TracerTest.java b/core/src/test/java/com/google/instrumentation/trace/TracerTest.java
index f76615eb..825b0f72 100644
--- a/core/src/test/java/com/google/instrumentation/trace/TracerTest.java
+++ b/core/src/test/java/com/google/instrumentation/trace/TracerTest.java
@@ -54,8 +54,8 @@ public class TracerTest {
 
   @Test
   public void defaultWithSpan() {
-    try (NonThrowingCloseable ss = tracer.withSpan(BlankSpan.getInstance())) {
-      assertThat(tracer.getCurrentSpan()).isEqualTo(BlankSpan.getInstance());
+    try (NonThrowingCloseable ss = tracer.withSpan(BlankSpan.INSTANCE)) {
+      assertThat(tracer.getCurrentSpan()).isEqualTo(BlankSpan.INSTANCE);
     }
   }
 
@@ -67,7 +67,7 @@ public class TracerTest {
   @Test
   public void defaultStartScopedSpanWithName() {
     try (NonThrowingCloseable ss = tracer.startScopedSpan("MySpanName")) {
-      assertThat(tracer.getCurrentSpan()).isEqualTo(BlankSpan.getInstance());
+      assertThat(tracer.getCurrentSpan()).isEqualTo(BlankSpan.INSTANCE);
     }
   }
 
@@ -85,7 +85,7 @@ public class TracerTest {
   public void defaultStartScopedSpanWithNameAndOptions() {
     try (NonThrowingCloseable ss =
         tracer.startScopedSpan("MySpanName", StartSpanOptions.getDefault())) {
-      assertThat(tracer.getCurrentSpan()).isEqualTo(BlankSpan.getInstance());
+      assertThat(tracer.getCurrentSpan()).isEqualTo(BlankSpan.INSTANCE);
     }
   }
 
@@ -97,7 +97,7 @@ public class TracerTest {
   @Test
   public void defaultStartScopedSpanWithParentAndName() {
     try (NonThrowingCloseable ss = tracer.startScopedSpan(null, "MySpanName")) {
-      assertThat(tracer.getCurrentSpan()).isEqualTo(BlankSpan.getInstance());
+      assertThat(tracer.getCurrentSpan()).isEqualTo(BlankSpan.INSTANCE);
     }
   }
 
@@ -116,7 +116,7 @@ public class TracerTest {
   public void defaultStartScopedSpanWithParentAndNameAndOptions() {
     try (NonThrowingCloseable ss =
         tracer.startScopedSpan(null, "MySpanName", StartSpanOptions.getDefault())) {
-      assertThat(tracer.getCurrentSpan()).isEqualTo(BlankSpan.getInstance());
+      assertThat(tracer.getCurrentSpan()).isEqualTo(BlankSpan.INSTANCE);
     }
   }
 
@@ -133,7 +133,7 @@ public class TracerTest {
   @Test
   public void defaultStartSpan() {
     assertThat(tracer.startSpan(null, "MySpanName", StartSpanOptions.getDefault()))
-        .isEqualTo(BlankSpan.getInstance());
+        .isEqualTo(BlankSpan.INSTANCE);
   }
 
   @Test(expected = NullPointerException.class)
@@ -149,7 +149,7 @@ public class TracerTest {
   @Test
   public void defaultStartSpanWitRemoteParent() {
     assertThat(tracer.startSpanWithRemoteParent(null, "MySpanName", StartSpanOptions.getDefault()))
-        .isEqualTo(BlankSpan.getInstance());
+        .isEqualTo(BlankSpan.INSTANCE);
   }
 
   @Test
@@ -230,7 +230,7 @@ public class TracerTest {
     Tracer mockTracer = newTracerWithMocks();
     when(contextSpanHandler.getCurrentSpan()).thenReturn(null);
     when(spanFactory.startSpan(
-            same(BlankSpan.getInstance()), eq("MySpanName"), same(StartSpanOptions.getDefault())))
+            same(BlankSpan.INSTANCE), eq("MySpanName"), same(StartSpanOptions.getDefault())))
         .thenReturn(span);
     when(contextSpanHandler.withSpan(same(span))).thenReturn(withSpan);
     try (NonThrowingCloseable ss = mockTracer.startScopedSpan("MySpanName")) {}
@@ -244,7 +244,7 @@ public class TracerTest {
     when(contextSpanHandler.getCurrentSpan()).thenReturn(null);
     StartSpanOptions startSpanOptions = StartSpanOptions.builder().build();
     when(spanFactory.startSpan(
-            same(BlankSpan.getInstance()), eq("MySpanName"), same(startSpanOptions)))
+            same(BlankSpan.INSTANCE), eq("MySpanName"), same(startSpanOptions)))
         .thenReturn(span);
     when(contextSpanHandler.withSpan(same(span))).thenReturn(withSpan);
     try (NonThrowingCloseable ss = mockTracer.startScopedSpan("MySpanName", startSpanOptions)) {}