Use a static method to access EMPTY InstrumentationLibraryInfo. (#897)

Signed-off-by: Bogdan Cristian Drutu <[email protected]>
open-telemetry · Feb 20, 2020 · aadea3d · aadea3d
1 parent 986a22e
commit aadea3d
Show file tree

Hide file tree

Showing 9 changed files with 35 additions and 16 deletions.
diff --git a/sdk/src/main/java/io/opentelemetry/sdk/common/InstrumentationLibraryInfo.java b/sdk/src/main/java/io/opentelemetry/sdk/common/InstrumentationLibraryInfo.java
@@ -29,7 +29,7 @@
 @AutoValue
 @Immutable
 public abstract class InstrumentationLibraryInfo {
-  public static final InstrumentationLibraryInfo EMPTY = create("", null);
+  private static final InstrumentationLibraryInfo EMPTY = create("", null);
 
   /**
    * Creates a new instance of {@link InstrumentationLibraryInfo}.
@@ -43,8 +43,27 @@ public static InstrumentationLibraryInfo create(String name, @Nullable String ve
     return new AutoValue_InstrumentationLibraryInfo(name, version);
   }
 
+  /**
+   * Returns an "empty" {@code InstrumentationLibraryInfo}.
+   *
+   * @return an "empty" {@code InstrumentationLibraryInfo}.
+   */
+  public static InstrumentationLibraryInfo getEmpty() {
+    return EMPTY;
+  }
+
+  /**
+   * Returns the name of the instrumentation library.
+   *
+   * @return the name of the instrumentation library.
+   */
   public abstract String getName();
 
+  /**
+   * Returns the version of the instrumentation library, or {@code null} if not available.
+   *
+   * @return the version of the instrumentation library, or {@code null} if not available.
+   */
   @Nullable
   public abstract String getVersion();
 

diff --git a/sdk/src/main/java/io/opentelemetry/sdk/trace/data/SpanData.java b/sdk/src/main/java/io/opentelemetry/sdk/trace/data/SpanData.java
@@ -292,7 +292,7 @@ public static TimedEvent create(
   public static Builder newBuilder() {
     return new AutoValue_SpanData.Builder()
         .setParentSpanId(SpanId.getInvalid())
-        .setInstrumentationLibraryInfo(InstrumentationLibraryInfo.EMPTY)
+        .setInstrumentationLibraryInfo(InstrumentationLibraryInfo.getEmpty())
         .setLinks(Collections.<io.opentelemetry.trace.Link>emptyList())
         .setTotalRecordedLinks(0)
         .setAttributes(Collections.<String, AttributeValue>emptyMap())

diff --git a/sdk/src/test/java/io/opentelemetry/sdk/common/InstrumentationLibraryInfoTest.java b/sdk/src/test/java/io/opentelemetry/sdk/common/InstrumentationLibraryInfoTest.java
@@ -31,8 +31,8 @@ public class InstrumentationLibraryInfoTest {
 
   @Test
   public void emptyLibraryInfo() {
-    assertThat(InstrumentationLibraryInfo.EMPTY.getName()).isEmpty();
-    assertThat(InstrumentationLibraryInfo.EMPTY.getVersion()).isNull();
+    assertThat(InstrumentationLibraryInfo.getEmpty().getName()).isEmpty();
+    assertThat(InstrumentationLibraryInfo.getEmpty().getVersion()).isNull();
   }
 
   @Test

diff --git a/sdk/src/test/java/io/opentelemetry/sdk/metrics/AbstractCounterBuilderTest.java b/sdk/src/test/java/io/opentelemetry/sdk/metrics/AbstractCounterBuilderTest.java
@@ -41,7 +41,7 @@ public class AbstractCounterBuilderTest {
   private static final MeterProviderSharedState METER_SHARED_STATE =
       MeterProviderSharedState.create(TestClock.create(), Resource.getEmpty());
   private static final InstrumentationLibraryInfo INSTRUMENTATION_LIBRARY_INFO =
-      InstrumentationLibraryInfo.EMPTY;
+      InstrumentationLibraryInfo.getEmpty();
 
   @Test
   public void defaultValue() {

diff --git a/sdk/src/test/java/io/opentelemetry/sdk/metrics/AbstractInstrumentBuilderTest.java b/sdk/src/test/java/io/opentelemetry/sdk/metrics/AbstractInstrumentBuilderTest.java
@@ -46,7 +46,7 @@ public class AbstractInstrumentBuilderTest {
   private static final MeterProviderSharedState METER_SHARED_STATE =
       MeterProviderSharedState.create(TestClock.create(), Resource.getEmpty());
   private static final InstrumentationLibraryInfo INSTRUMENTATION_LIBRARY_INFO =
-      InstrumentationLibraryInfo.EMPTY;
+      InstrumentationLibraryInfo.getEmpty();
 
   @Test
   public void preventNull_Name() {

diff --git a/sdk/src/test/java/io/opentelemetry/sdk/metrics/AbstractMeasureBuilderTest.java b/sdk/src/test/java/io/opentelemetry/sdk/metrics/AbstractMeasureBuilderTest.java
@@ -41,7 +41,7 @@ public class AbstractMeasureBuilderTest {
   private static final MeterProviderSharedState METER_SHARED_STATE =
       MeterProviderSharedState.create(TestClock.create(), Resource.getEmpty());
   private static final InstrumentationLibraryInfo INSTRUMENTATION_LIBRARY_INFO =
-      InstrumentationLibraryInfo.EMPTY;
+      InstrumentationLibraryInfo.getEmpty();
 
   @Test
   public void defaultValue() {

diff --git a/sdk/src/test/java/io/opentelemetry/sdk/metrics/AbstractObserverBuilderTest.java b/sdk/src/test/java/io/opentelemetry/sdk/metrics/AbstractObserverBuilderTest.java
@@ -38,7 +38,7 @@ public class AbstractObserverBuilderTest {
   private static final MeterProviderSharedState METER_SHARED_STATE =
       MeterProviderSharedState.create(TestClock.create(), Resource.getEmpty());
   private static final InstrumentationLibraryInfo INSTRUMENTATION_LIBRARY_INFO =
-      InstrumentationLibraryInfo.EMPTY;
+      InstrumentationLibraryInfo.getEmpty();
 
   @Test
   public void defaultValue() {

diff --git a/sdk/src/test/java/io/opentelemetry/sdk/metrics/data/MetricDataTest.java b/sdk/src/test/java/io/opentelemetry/sdk/metrics/data/MetricDataTest.java
@@ -69,7 +69,7 @@ public void metricData_NullDescriptor() {
     MetricData.create(
         null,
         Resource.getEmpty(),
-        InstrumentationLibraryInfo.EMPTY,
+        InstrumentationLibraryInfo.getEmpty(),
         Collections.<Point>singletonList(DOUBLE_POINT));
   }
 
@@ -80,7 +80,7 @@ public void metricData_NullResource() {
     MetricData.create(
         LONG_METRIC_DESCRIPTOR,
         null,
-        InstrumentationLibraryInfo.EMPTY,
+        InstrumentationLibraryInfo.getEmpty(),
         Collections.<Point>singletonList(DOUBLE_POINT));
   }
 
@@ -100,7 +100,7 @@ public void metricData_NullPoints() {
     thrown.expect(NullPointerException.class);
     thrown.expectMessage("points");
     MetricData.create(
-        LONG_METRIC_DESCRIPTOR, Resource.getEmpty(), InstrumentationLibraryInfo.EMPTY, null);
+        LONG_METRIC_DESCRIPTOR, Resource.getEmpty(), InstrumentationLibraryInfo.getEmpty(), null);
   }
 
   @Test
@@ -109,12 +109,12 @@ public void metricData_Getters() {
         MetricData.create(
             LONG_METRIC_DESCRIPTOR,
             Resource.getEmpty(),
-            InstrumentationLibraryInfo.EMPTY,
+            InstrumentationLibraryInfo.getEmpty(),
             Collections.<Point>emptyList());
     assertThat(metricData.getDescriptor()).isEqualTo(LONG_METRIC_DESCRIPTOR);
     assertThat(metricData.getResource()).isEqualTo(Resource.getEmpty());
     assertThat(metricData.getInstrumentationLibraryInfo())
-        .isEqualTo(InstrumentationLibraryInfo.EMPTY);
+        .isEqualTo(InstrumentationLibraryInfo.getEmpty());
     assertThat(metricData.getPoints()).isEmpty();
   }
 
@@ -128,7 +128,7 @@ public void metricData_LongPoints() {
         MetricData.create(
             LONG_METRIC_DESCRIPTOR,
             Resource.getEmpty(),
-            InstrumentationLibraryInfo.EMPTY,
+            InstrumentationLibraryInfo.getEmpty(),
             Collections.<Point>singletonList(LONG_POINT));
     assertThat(metricData.getPoints()).containsExactly(LONG_POINT);
   }
@@ -143,7 +143,7 @@ public void metricData_DoublePoints() {
         MetricData.create(
             DOUBLE_METRIC_DESCRIPTOR,
             Resource.getEmpty(),
-            InstrumentationLibraryInfo.EMPTY,
+            InstrumentationLibraryInfo.getEmpty(),
             Collections.<Point>singletonList(DOUBLE_POINT));
     assertThat(metricData.getPoints()).containsExactly(DOUBLE_POINT);
   }

diff --git a/sdk/src/test/java/io/opentelemetry/sdk/trace/data/SpanDataTest.java b/sdk/src/test/java/io/opentelemetry/sdk/trace/data/SpanDataTest.java
@@ -57,7 +57,7 @@ public void defaultValues() {
     assertThat(spanData.getTimedEvents()).isEqualTo(emptyList());
     assertThat(spanData.getLinks()).isEqualTo(emptyList());
     assertThat(spanData.getInstrumentationLibraryInfo())
-        .isSameInstanceAs(InstrumentationLibraryInfo.EMPTY);
+        .isSameInstanceAs(InstrumentationLibraryInfo.getEmpty());
     assertThat(spanData.getHasRemoteParent()).isFalse();
   }