Skip to content

Commit bee7c5f

Browse files
m15om15o
authored
Add @Nullable annotations (#744)
* Added `@Nullable` annotations to method parameters and return values * Fixed that `OtelSpan.event()` does not return null
1 parent f2764ad commit bee7c5f

File tree

22 files changed

+89
-30
lines changed

22 files changed

+89
-30
lines changed

‎micrometer-tracing-bridges/micrometer-tracing-bridge-brave/src/main/java/io/micrometer/tracing/brave/bridge/BraveBaggageInScope.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,11 +66,13 @@ public String name() {
6666
}
6767

6868
@Override
69+
@Nullable
6970
public String get() {
7071
return this.traceContext != null ? this.delegate.getValue(traceContext) : this.delegate.getValue();
7172
}
7273

7374
@Override
75+
@Nullable
7476
public String get(TraceContext traceContext) {
7577
return this.delegate.getValue(BraveTraceContext.toBrave(traceContext));
7678
}

‎micrometer-tracing-bridges/micrometer-tracing-bridge-brave/src/main/java/io/micrometer/tracing/brave/bridge/BraveBaggageManager.java‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ public Map<String, String> getAllBaggage() {
8484
}
8585

8686
@Override
87-
public Map<String, String> getAllBaggage(TraceContext traceContext) {
87+
public Map<String, String> getAllBaggage(@Nullable TraceContext traceContext) {
8888
if (traceContext == null) {
8989
return getAllBaggage();
9090
}
@@ -97,6 +97,7 @@ public Baggage getBaggage(String name) {
9797
}
9898

9999
@Override
100+
@Nullable
100101
public Baggage getBaggage(TraceContext traceContext, String name) {
101102
BaggageField baggageField = BaggageField.getByName(BraveTraceContext.toBrave(traceContext), name);
102103
if (baggageField == null) {
@@ -125,6 +126,7 @@ private BraveBaggageInScope baggage(String name) {
125126
}
126127

127128
// Taken from BraveField
129+
@Nullable
128130
private Span currentSpan() {
129131
if (tracer != null) {
130132
io.micrometer.tracing.Span span = tracer.currentSpan();

‎micrometer-tracing-bridges/micrometer-tracing-bridge-brave/src/main/java/io/micrometer/tracing/brave/bridge/BraveCurrentTraceContext.java‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
*/
1616
package io.micrometer.tracing.brave.bridge;
1717

18+
import io.micrometer.common.lang.Nullable;
1819
import io.micrometer.tracing.CurrentTraceContext;
1920
import io.micrometer.tracing.TraceContext;
2021

@@ -59,6 +60,7 @@ public static CurrentTraceContext fromBrave(brave.propagation.CurrentTraceContex
5960
}
6061

6162
@Override
63+
@Nullable
6264
public TraceContext context() {
6365
brave.propagation.TraceContext context = this.delegate.get();
6466
if (context == null) {
@@ -68,13 +70,13 @@ public TraceContext context() {
6870
}
6971

7072
@Override
71-
public Scope newScope(TraceContext context) {
73+
public Scope newScope(@Nullable TraceContext context) {
7274
return new BraveScope(
7375
this.delegate.newScope(io.micrometer.tracing.brave.bridge.BraveTraceContext.toBrave(context)));
7476
}
7577

7678
@Override
77-
public Scope maybeScope(TraceContext context) {
79+
public Scope maybeScope(@Nullable TraceContext context) {
7880
return new BraveScope(
7981
this.delegate.maybeScope(io.micrometer.tracing.brave.bridge.BraveTraceContext.toBrave(context)));
8082
}

‎micrometer-tracing-bridges/micrometer-tracing-bridge-brave/src/main/java/io/micrometer/tracing/brave/bridge/BraveFinishedSpan.java‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
package io.micrometer.tracing.brave.bridge;
1717

1818
import brave.handler.MutableSpan;
19+
import io.micrometer.common.lang.Nullable;
1920
import io.micrometer.tracing.Link;
2021
import io.micrometer.tracing.Span;
2122
import io.micrometer.tracing.TraceContext;
@@ -154,6 +155,7 @@ public String getTraceId() {
154155
}
155156

156157
@Override
158+
@Nullable
157159
public Throwable getError() {
158160
return this.mutableSpan.error();
159161
}
@@ -173,6 +175,7 @@ public Span.Kind getKind() {
173175
}
174176

175177
@Override
178+
@Nullable
176179
public String getRemoteServiceName() {
177180
return this.mutableSpan.remoteServiceName();
178181
}

‎micrometer-tracing-bridges/micrometer-tracing-bridge-brave/src/main/java/io/micrometer/tracing/brave/bridge/BravePropagator.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
import brave.baggage.BaggageField;
2020
import brave.internal.baggage.BaggageFields;
2121
import brave.propagation.TraceContextOrSamplingFlags;
22+
import io.micrometer.common.lang.Nullable;
2223
import io.micrometer.tracing.Span;
2324
import io.micrometer.tracing.TraceContext;
2425
import io.micrometer.tracing.propagation.Propagator;
@@ -49,7 +50,7 @@ public List<String> fields() {
4950
}
5051

5152
@Override
52-
public <C> void inject(TraceContext traceContext, C carrier, Setter<C> setter) {
53+
public <C> void inject(TraceContext traceContext, @Nullable C carrier, Setter<C> setter) {
5354
this.tracing.propagation().injector(setter::set).inject(BraveTraceContext.toBrave(traceContext), carrier);
5455
}
5556

‎micrometer-tracing-bridges/micrometer-tracing-bridge-brave/src/main/java/io/micrometer/tracing/brave/bridge/BraveSpan.java‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
import java.util.Objects;
1919
import java.util.concurrent.TimeUnit;
2020

21+
import io.micrometer.common.lang.Nullable;
2122
import io.micrometer.tracing.Span;
2223
import io.micrometer.tracing.TraceContext;
2324

@@ -44,7 +45,8 @@ public BraveSpan(brave.Span delegate) {
4445
* @param span Tracing version
4546
* @return Brave's version
4647
*/
47-
public static brave.Span toBrave(Span span) {
48+
@Nullable
49+
public static brave.Span toBrave(@Nullable Span span) {
4850
BraveSpan braveSpan = (BraveSpan) span;
4951
if (braveSpan == null) {
5052
return null;

‎micrometer-tracing-bridges/micrometer-tracing-bridge-brave/src/main/java/io/micrometer/tracing/brave/bridge/BraveTraceContext.java‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,8 @@ public BraveTraceContext(brave.propagation.TraceContext traceContext) {
4343
* @param traceContext Tracing version
4444
* @return Brave version
4545
*/
46-
public static brave.propagation.TraceContext toBrave(TraceContext traceContext) {
46+
@Nullable
47+
public static brave.propagation.TraceContext toBrave(@Nullable TraceContext traceContext) {
4748
if (traceContext == null) {
4849
return null;
4950
}
@@ -76,6 +77,7 @@ public String spanId() {
7677
}
7778

7879
@Override
80+
@Nullable
7981
public Boolean sampled() {
8082
return this.traceContext.sampled();
8183
}

‎micrometer-tracing-bridges/micrometer-tracing-bridge-brave/src/main/java/io/micrometer/tracing/brave/bridge/BraveTracer.java‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
package io.micrometer.tracing.brave.bridge;
1717

1818
import brave.propagation.TraceContextOrSamplingFlags;
19+
import io.micrometer.common.lang.Nullable;
1920
import io.micrometer.tracing.*;
2021

2122
import java.util.List;
@@ -60,7 +61,8 @@ public BraveTracer(brave.Tracer tracer, CurrentTraceContext context) {
6061
}
6162

6263
@Override
63-
public Span nextSpan(Span parent) {
64+
@Nullable
65+
public Span nextSpan(@Nullable Span parent) {
6466
if (parent == null) {
6567
return nextSpan();
6668
}
@@ -72,7 +74,7 @@ public Span nextSpan(Span parent) {
7274
}
7375

7476
@Override
75-
public SpanInScope withSpan(Span span) {
77+
public SpanInScope withSpan(@Nullable Span span) {
7678
return new BraveSpanInScope(tracer.withSpanInScope(span == null ? null : ((BraveSpan) span).delegate));
7779
}
7880

@@ -82,6 +84,7 @@ public SpanCustomizer currentSpanCustomizer() {
8284
}
8385

8486
@Override
87+
@Nullable
8588
public Span currentSpan() {
8689
brave.Span currentSpan = this.tracer.currentSpan();
8790
if (currentSpan == null) {
@@ -111,7 +114,7 @@ public TraceContext.Builder traceContextBuilder() {
111114
}
112115

113116
@Override
114-
public Map<String, String> getAllBaggage(TraceContext traceContext) {
117+
public Map<String, String> getAllBaggage(@Nullable TraceContext traceContext) {
115118
return this.braveBaggageManager.getAllBaggage(traceContext);
116119
}
117120

@@ -121,11 +124,13 @@ public Map<String, String> getAllBaggage() {
121124
}
122125

123126
@Override
127+
@Nullable
124128
public Baggage getBaggage(String name) {
125129
return this.braveBaggageManager.getBaggage(name);
126130
}
127131

128132
@Override
133+
@Nullable
129134
public Baggage getBaggage(TraceContext traceContext, String name) {
130135
return this.braveBaggageManager.getBaggage(traceContext, name);
131136
}

‎micrometer-tracing-bridges/micrometer-tracing-bridge-brave/src/main/java/io/micrometer/tracing/brave/bridge/LinkUtils.java‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
*/
1616
package io.micrometer.tracing.brave.bridge;
1717

18+
import io.micrometer.common.lang.Nullable;
1819
import io.micrometer.common.util.StringUtils;
1920
import io.micrometer.tracing.Link;
2021
import io.micrometer.tracing.TraceContext;
@@ -74,6 +75,7 @@ static int nextIndex(Map<String, String> tags) {
7475
.size();
7576
}
7677

78+
@Nullable
7779
static Link toLink(List<Map.Entry<String, String>> groupedTags) {
7880
String traceId = "";
7981
String spanId = "";
@@ -119,6 +121,7 @@ static long spanId(String spanId) {
119121
return fromString[fromString.length == 2 ? 1 : 0];
120122
}
121123

124+
@Nullable
122125
static String tagKeyNameFromString(String tag) {
123126
Matcher matcher = TAG_KEY.matcher(tag);
124127
if (matcher.matches()) {

‎micrometer-tracing-bridges/micrometer-tracing-bridge-otel/src/main/java/io/micrometer/tracing/otel/bridge/EventPublishingContextWrapper.java‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ public static class ScopeAttachedEvent {
7676
/**
7777
* Context corresponding to the attached scope. Might be {@code null}.
7878
*/
79+
@Nullable
7980
final Context context;
8081

8182
/**
@@ -86,10 +87,12 @@ public ScopeAttachedEvent(@Nullable Context context) {
8687
this.context = context;
8788
}
8889

90+
@Nullable
8991
public Span getSpan() {
9092
return Span.fromContextOrNull(context);
9193
}
9294

95+
@Nullable
9396
public Baggage getBaggage() {
9497
return Baggage.fromContextOrNull(context);
9598
}
@@ -117,6 +120,7 @@ public static class ScopeRestoredEvent {
117120
* {@link Context} corresponding to the scope being restored. Might be
118121
* {@code null}.
119122
*/
123+
@Nullable
120124
final Context context;
121125

122126
/**
@@ -127,10 +131,12 @@ public ScopeRestoredEvent(@Nullable Context context) {
127131
this.context = context;
128132
}
129133

134+
@Nullable
130135
public Span getSpan() {
131136
return Span.fromContextOrNull(context);
132137
}
133138

139+
@Nullable
134140
public Baggage getBaggage() {
135141
return Baggage.fromContextOrNull(context);
136142
}

0 commit comments

Comments
 (0)