Clarify the nature of the Link.Type enum (#413)

8 files changed, 28 insertions, 27 deletions

diff --git a/api/src/main/java/io/opencensus/trace/base/Link.java b/api/src/main/java/io/opencensus/trace/base/Link.java
index 363bd212..3f8b93f8 100644
--- a/api/src/main/java/io/opencensus/trace/base/Link.java
+++ b/api/src/main/java/io/opencensus/trace/base/Link.java
@@ -33,9 +33,9 @@ public abstract class Link {
   /** The relationship with the linked {@code Span} relative to the current {@code Span}. */
   public enum Type {
     /** When the linked {@code Span} is a child of the current {@code Span}. */
-    CHILD,
+    CHILD_LINKED_SPAN,
     /** When the linked {@code Span} is a parent of the current {@code Span}. */
-    PARENT
+    PARENT_LINKED_SPAN
   }
 
   /**
diff --git a/api/src/test/java/io/opencensus/trace/BlankSpanTest.java b/api/src/test/java/io/opencensus/trace/BlankSpanTest.java
index c62b5bf6..f9690321 100644
--- a/api/src/test/java/io/opencensus/trace/BlankSpanTest.java
+++ b/api/src/test/java/io/opencensus/trace/BlankSpanTest.java
@@ -52,7 +52,8 @@ public class BlankSpanTest {
     BlankSpan.INSTANCE.addAnnotation("MyAnnotation", multipleAttributes);
     BlankSpan.INSTANCE.addAnnotation(Annotation.fromDescription("MyAnnotation"));
     BlankSpan.INSTANCE.addNetworkEvent(NetworkEvent.builder(NetworkEvent.Type.SENT, 1L).build());
-    BlankSpan.INSTANCE.addLink(Link.fromSpanContext(SpanContext.INVALID, Link.Type.CHILD));
+    BlankSpan.INSTANCE.addLink(
+        Link.fromSpanContext(SpanContext.INVALID, Link.Type.CHILD_LINKED_SPAN));
     BlankSpan.INSTANCE.end(EndSpanOptions.DEFAULT);
     BlankSpan.INSTANCE.end();
   }
diff --git a/api/src/test/java/io/opencensus/trace/base/LinkTest.java b/api/src/test/java/io/opencensus/trace/base/LinkTest.java
index 4fafa02a..d0bfc46e 100644
--- a/api/src/test/java/io/opencensus/trace/base/LinkTest.java
+++ b/api/src/test/java/io/opencensus/trace/base/LinkTest.java
@@ -33,18 +33,18 @@ public class LinkTest {
 
   @Test
   public void fromSpanContext_ChildLink() {
-    Link link = Link.fromSpanContext(spanContext, Type.CHILD);
+    Link link = Link.fromSpanContext(spanContext, Type.CHILD_LINKED_SPAN);
     assertThat(link.getTraceId()).isEqualTo(spanContext.getTraceId());
     assertThat(link.getSpanId()).isEqualTo(spanContext.getSpanId());
-    assertThat(link.getType()).isEqualTo(Type.CHILD);
+    assertThat(link.getType()).isEqualTo(Type.CHILD_LINKED_SPAN);
   }
 
   @Test
   public void fromSpanContext_ParentLink() {
-    Link link = Link.fromSpanContext(spanContext, Type.PARENT);
+    Link link = Link.fromSpanContext(spanContext, Type.PARENT_LINKED_SPAN);
     assertThat(link.getTraceId()).isEqualTo(spanContext.getTraceId());
     assertThat(link.getSpanId()).isEqualTo(spanContext.getSpanId());
-    assertThat(link.getType()).isEqualTo(Type.PARENT);
+    assertThat(link.getType()).isEqualTo(Type.PARENT_LINKED_SPAN);
   }
 
   @Test
@@ -52,25 +52,25 @@ public class LinkTest {
     EqualsTester tester = new EqualsTester();
     tester
         .addEqualityGroup(
-            Link.fromSpanContext(spanContext, Type.PARENT),
-            Link.fromSpanContext(spanContext, Type.PARENT))
+            Link.fromSpanContext(spanContext, Type.PARENT_LINKED_SPAN),
+            Link.fromSpanContext(spanContext, Type.PARENT_LINKED_SPAN))
         .addEqualityGroup(
-            Link.fromSpanContext(spanContext, Type.CHILD),
-            Link.fromSpanContext(spanContext, Type.CHILD))
-        .addEqualityGroup(Link.fromSpanContext(SpanContext.INVALID, Type.CHILD))
-        .addEqualityGroup(Link.fromSpanContext(SpanContext.INVALID, Type.PARENT));
+            Link.fromSpanContext(spanContext, Type.CHILD_LINKED_SPAN),
+            Link.fromSpanContext(spanContext, Type.CHILD_LINKED_SPAN))
+        .addEqualityGroup(Link.fromSpanContext(SpanContext.INVALID, Type.CHILD_LINKED_SPAN))
+        .addEqualityGroup(Link.fromSpanContext(SpanContext.INVALID, Type.PARENT_LINKED_SPAN));
     tester.testEquals();
   }
 
   @Test
   public void link_ToString() {
-    Link link = Link.fromSpanContext(spanContext, Type.CHILD);
+    Link link = Link.fromSpanContext(spanContext, Type.CHILD_LINKED_SPAN);
     assertThat(link.toString()).contains(spanContext.getTraceId().toString());
     assertThat(link.toString()).contains(spanContext.getSpanId().toString());
-    assertThat(link.toString()).contains("CHILD");
-    link = Link.fromSpanContext(spanContext, Type.PARENT);
+    assertThat(link.toString()).contains("CHILD_LINKED_SPAN");
+    link = Link.fromSpanContext(spanContext, Type.PARENT_LINKED_SPAN);
     assertThat(link.toString()).contains(spanContext.getTraceId().toString());
     assertThat(link.toString()).contains(spanContext.getSpanId().toString());
-    assertThat(link.toString()).contains("PARENT");
+    assertThat(link.toString()).contains("PARENT_LINKED_SPAN");
   }
 }
diff --git a/api/src/test/java/io/opencensus/trace/export/SpanDataTest.java b/api/src/test/java/io/opencensus/trace/export/SpanDataTest.java
index 1a92b0e6..6ea20fcc 100644
--- a/api/src/test/java/io/opencensus/trace/export/SpanDataTest.java
+++ b/api/src/test/java/io/opencensus/trace/export/SpanDataTest.java
@@ -85,7 +85,7 @@ public class SpanDataTest {
     networkEventsList.add(SpanData.TimedEvent.create(eventTimestamp1, recvNetworkEvent));
     networkEventsList.add(SpanData.TimedEvent.create(eventTimestamp2, sentNetworkEvent));
     networkEvents = TimedEvents.create(networkEventsList, 3);
-    linksList.add(Link.fromSpanContext(spanContext, Type.CHILD));
+    linksList.add(Link.fromSpanContext(spanContext, Type.CHILD_LINKED_SPAN));
     links = Links.create(linksList, 0);
   }
 
diff --git a/benchmarks/src/jmh/java/io/opencensus/trace/RecordTraceEventsNonSampledSpanBenchmark.java b/benchmarks/src/jmh/java/io/opencensus/trace/RecordTraceEventsNonSampledSpanBenchmark.java
index 2a6872d0..00f68efd 100644
--- a/benchmarks/src/jmh/java/io/opencensus/trace/RecordTraceEventsNonSampledSpanBenchmark.java
+++ b/benchmarks/src/jmh/java/io/opencensus/trace/RecordTraceEventsNonSampledSpanBenchmark.java
@@ -87,7 +87,7 @@ public class RecordTraceEventsNonSampledSpanBenchmark {
   @BenchmarkMode(Mode.SampleTime)
   @OutputTimeUnit(TimeUnit.NANOSECONDS)
   public Span addLink() {
-    span.addLink(Link.fromSpanContext(linkedSpan.getContext(), Link.Type.PARENT));
+    span.addLink(Link.fromSpanContext(linkedSpan.getContext(), Link.Type.PARENT_LINKED_SPAN));
     return span;
   }
 }
diff --git a/benchmarks/src/jmh/java/io/opencensus/trace/RecordTraceEventsSampledSpanBenchmark.java b/benchmarks/src/jmh/java/io/opencensus/trace/RecordTraceEventsSampledSpanBenchmark.java
index db591f55..de821b06 100644
--- a/benchmarks/src/jmh/java/io/opencensus/trace/RecordTraceEventsSampledSpanBenchmark.java
+++ b/benchmarks/src/jmh/java/io/opencensus/trace/RecordTraceEventsSampledSpanBenchmark.java
@@ -87,7 +87,7 @@ public class RecordTraceEventsSampledSpanBenchmark {
   @BenchmarkMode(Mode.SampleTime)
   @OutputTimeUnit(TimeUnit.NANOSECONDS)
   public Span addLink() {
-    span.addLink(Link.fromSpanContext(linkedSpan.getContext(), Link.Type.PARENT));
+    span.addLink(Link.fromSpanContext(linkedSpan.getContext(), Link.Type.PARENT_LINKED_SPAN));
     return span;
   }
 }
diff --git a/impl_core/src/main/java/io/opencensus/trace/SpanBuilderImpl.java b/impl_core/src/main/java/io/opencensus/trace/SpanBuilderImpl.java
index 977baabf..e001d4b2 100644
--- a/impl_core/src/main/java/io/opencensus/trace/SpanBuilderImpl.java
+++ b/impl_core/src/main/java/io/opencensus/trace/SpanBuilderImpl.java
@@ -96,10 +96,10 @@ final class SpanBuilderImpl extends SpanBuilder {
 
   private static void linkSpans(Span span, List<Span> parentLinks) {
     if (!parentLinks.isEmpty()) {
-      Link childLink = Link.fromSpanContext(span.getContext(), Type.CHILD);
+      Link childLink = Link.fromSpanContext(span.getContext(), Type.CHILD_LINKED_SPAN);
       for (Span linkedSpan : parentLinks) {
         linkedSpan.addLink(childLink);
-        span.addLink(Link.fromSpanContext(linkedSpan.getContext(), Type.PARENT));
+        span.addLink(Link.fromSpanContext(linkedSpan.getContext(), Type.PARENT_LINKED_SPAN));
       }
     }
   }
diff --git a/impl_core/src/test/java/io/opencensus/trace/SpanImplTest.java b/impl_core/src/test/java/io/opencensus/trace/SpanImplTest.java
index 451aabd5..4db23b2f 100644
--- a/impl_core/src/test/java/io/opencensus/trace/SpanImplTest.java
+++ b/impl_core/src/test/java/io/opencensus/trace/SpanImplTest.java
@@ -91,7 +91,7 @@ public class SpanImplTest {
     span.addAnnotation(Annotation.fromDescription(ANNOTATION_DESCRIPTION));
     span.addAnnotation(ANNOTATION_DESCRIPTION, attributes);
     span.addNetworkEvent(NetworkEvent.builder(NetworkEvent.Type.RECV, 1).setMessageSize(3).build());
-    span.addLink(Link.fromSpanContext(spanContext, Link.Type.CHILD));
+    span.addLink(Link.fromSpanContext(spanContext, Link.Type.CHILD_LINKED_SPAN));
     span.end();
     exception.expect(IllegalStateException.class);
     span.toSpanData();
@@ -117,7 +117,7 @@ public class SpanImplTest {
     span.addAnnotation(Annotation.fromDescription(ANNOTATION_DESCRIPTION));
     span.addAnnotation(ANNOTATION_DESCRIPTION, attributes);
     span.addNetworkEvent(NetworkEvent.builder(NetworkEvent.Type.RECV, 1).setMessageSize(3).build());
-    span.addLink(Link.fromSpanContext(spanContext, Link.Type.CHILD));
+    span.addLink(Link.fromSpanContext(spanContext, Link.Type.CHILD_LINKED_SPAN));
     SpanData spanData = span.toSpanData();
     assertThat(spanData.getStartTimestamp()).isEqualTo(timestamp);
     assertThat(spanData.getAttributes().getAttributeMap()).isEmpty();
@@ -152,7 +152,7 @@ public class SpanImplTest {
         NetworkEvent.builder(NetworkEvent.Type.RECV, 1).setMessageSize(3).build();
     span.addNetworkEvent(networkEvent);
     testClock.advanceTime(Duration.create(0, 100));
-    Link link = Link.fromSpanContext(spanContext, Link.Type.CHILD);
+    Link link = Link.fromSpanContext(spanContext, Link.Type.CHILD_LINKED_SPAN);
     span.addLink(link);
     SpanData spanData = span.toSpanData();
     assertThat(spanData.getContext()).isEqualTo(spanContext);
@@ -207,7 +207,7 @@ public class SpanImplTest {
     NetworkEvent networkEvent =
         NetworkEvent.builder(NetworkEvent.Type.RECV, 1).setMessageSize(3).build();
     span.addNetworkEvent(networkEvent);
-    Link link = Link.fromSpanContext(spanContext, Link.Type.CHILD);
+    Link link = Link.fromSpanContext(spanContext, Link.Type.CHILD_LINKED_SPAN);
     span.addLink(link);
     testClock.advanceTime(Duration.create(0, 100));
     span.end(EndSpanOptions.builder().setStatus(Status.CANCELLED).build());
@@ -450,7 +450,7 @@ public class SpanImplTest {
             startEndHandler,
             timestampConverter,
             testClock);
-    Link link = Link.fromSpanContext(spanContext, Link.Type.CHILD);
+    Link link = Link.fromSpanContext(spanContext, Link.Type.CHILD_LINKED_SPAN);
     for (int i = 0; i < 2 * maxNumberOfLinks; i++) {
       span.addLink(link);
     }