From 9d84812de80707a4428f49b9bd942a10bb7a96bc Mon Sep 17 00:00:00 2001 From: Marcin Grzejszczak Date: Mon, 8 May 2017 11:26:10 +0200 Subject: [PATCH] Added javadocs for SpanAccessor, fixes #587 --- .../org/springframework/cloud/sleuth/SpanAccessor.java | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/SpanAccessor.java b/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/SpanAccessor.java index 19b2997a7..b609a490b 100644 --- a/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/SpanAccessor.java +++ b/spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/SpanAccessor.java @@ -26,8 +26,16 @@ package org.springframework.cloud.sleuth; */ public interface SpanAccessor { + /** + * Retrieves the span that is present in the context. If currently there is + * no tracing going on, then this method will return {@code null}. + */ Span getCurrentSpan(); + /** + * Returns {@code true} when a span is present in the current context. In other + * words if a span was started or continued then this method returns {@code true}. + */ boolean isTracing(); }