Skip to content

Commit 7b5d069

Browse files
authored
Replace jsr305's CheckReturnValue with Error Prone's (#11811)
We should avoid jsr305 and error prone's has the same semantics. Fixes #8687
1 parent 73721ac commit 7b5d069

35 files changed

+35
-33
lines changed

api/src/main/java/io/grpc/CallOptions.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,14 @@
2121

2222
import com.google.common.base.MoreObjects;
2323
import com.google.common.base.Preconditions;
24+
import com.google.errorprone.annotations.CheckReturnValue;
2425
import java.time.Duration;
2526
import java.util.ArrayList;
2627
import java.util.Arrays;
2728
import java.util.Collections;
2829
import java.util.List;
2930
import java.util.concurrent.Executor;
3031
import java.util.concurrent.TimeUnit;
31-
import javax.annotation.CheckReturnValue;
3232
import javax.annotation.Nullable;
3333
import javax.annotation.concurrent.Immutable;
3434

api/src/main/java/io/grpc/MethodDescriptor.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@
2020

2121
import com.google.common.base.MoreObjects;
2222
import com.google.common.base.Preconditions;
23+
import com.google.errorprone.annotations.CheckReturnValue;
2324
import java.io.InputStream;
2425
import java.util.concurrent.atomic.AtomicReferenceArray;
25-
import javax.annotation.CheckReturnValue;
2626
import javax.annotation.Nullable;
2727
import javax.annotation.concurrent.Immutable;
2828

api/src/main/java/io/grpc/Status.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,14 @@
2323

2424
import com.google.common.base.MoreObjects;
2525
import com.google.common.base.Objects;
26+
import com.google.errorprone.annotations.CheckReturnValue;
2627
import io.grpc.Metadata.TrustedAsciiMarshaller;
2728
import java.nio.ByteBuffer;
2829
import java.util.ArrayList;
2930
import java.util.Arrays;
3031
import java.util.Collections;
3132
import java.util.List;
3233
import java.util.TreeMap;
33-
import javax.annotation.CheckReturnValue;
3434
import javax.annotation.Nullable;
3535
import javax.annotation.concurrent.Immutable;
3636

api/src/testFixtures/java/io/grpc/testing/DeadlineSubject.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@
2424
import com.google.common.truth.ComparableSubject;
2525
import com.google.common.truth.FailureMetadata;
2626
import com.google.common.truth.Subject;
27+
import com.google.errorprone.annotations.CheckReturnValue;
2728
import io.grpc.Deadline;
2829
import java.util.concurrent.TimeUnit;
29-
import javax.annotation.CheckReturnValue;
3030
import javax.annotation.Nullable;
3131

3232
/** Propositions for {@link Deadline} subjects. */

binder/src/main/java/io/grpc/binder/AsyncSecurityPolicy.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@
1717
package io.grpc.binder;
1818

1919
import com.google.common.util.concurrent.ListenableFuture;
20+
import com.google.errorprone.annotations.CheckReturnValue;
2021
import io.grpc.ExperimentalApi;
2122
import io.grpc.Status;
2223
import java.util.concurrent.CancellationException;
2324
import java.util.concurrent.ExecutionException;
24-
import javax.annotation.CheckReturnValue;
2525

2626
/**
2727
* Decides whether a given Android UID is authorized to access some resource.

binder/src/main/java/io/grpc/binder/SecurityPolicy.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@
1616

1717
package io.grpc.binder;
1818

19+
import com.google.errorprone.annotations.CheckReturnValue;
1920
import io.grpc.Status;
20-
import javax.annotation.CheckReturnValue;
2121

2222
/**
2323
* Decides whether a given Android UID is authorized to access some resource.

binder/src/main/java/io/grpc/binder/ServerSecurityPolicy.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@
1919
import com.google.common.collect.ImmutableMap;
2020
import com.google.common.util.concurrent.Futures;
2121
import com.google.common.util.concurrent.ListenableFuture;
22+
import com.google.errorprone.annotations.CheckReturnValue;
2223
import io.grpc.Status;
2324
import java.util.HashMap;
2425
import java.util.Map;
25-
import javax.annotation.CheckReturnValue;
2626

2727
/**
2828
* A security policy for a gRPC server.

binder/src/main/java/io/grpc/binder/UntrustedSecurityPolicies.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@
1616

1717
package io.grpc.binder;
1818

19+
import com.google.errorprone.annotations.CheckReturnValue;
1920
import io.grpc.ExperimentalApi;
2021
import io.grpc.Status;
21-
import javax.annotation.CheckReturnValue;
2222

2323
/** Static factory methods for creating untrusted security policies. */
2424
@CheckReturnValue

binder/src/main/java/io/grpc/binder/internal/BinderTransport.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
import com.google.common.util.concurrent.FutureCallback;
3636
import com.google.common.util.concurrent.Futures;
3737
import com.google.common.util.concurrent.ListenableFuture;
38+
import com.google.errorprone.annotations.CheckReturnValue;
3839
import io.grpc.Attributes;
3940
import io.grpc.CallOptions;
4041
import io.grpc.ClientStreamTracer;
@@ -78,7 +79,6 @@
7879
import java.util.concurrent.atomic.AtomicLong;
7980
import java.util.logging.Level;
8081
import java.util.logging.Logger;
81-
import javax.annotation.CheckReturnValue;
8282
import javax.annotation.Nullable;
8383
import javax.annotation.concurrent.GuardedBy;
8484
import javax.annotation.concurrent.ThreadSafe;

binder/src/main/java/io/grpc/binder/internal/BinderTransportSecurity.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
import com.google.common.util.concurrent.Futures;
2121
import com.google.common.util.concurrent.ListenableFuture;
2222
import com.google.common.util.concurrent.MoreExecutors;
23+
import com.google.errorprone.annotations.CheckReturnValue;
2324
import io.grpc.Attributes;
2425
import io.grpc.Internal;
2526
import io.grpc.Metadata;
@@ -35,7 +36,6 @@
3536
import java.util.concurrent.ConcurrentHashMap;
3637
import java.util.concurrent.ExecutionException;
3738
import java.util.concurrent.Executor;
38-
import javax.annotation.CheckReturnValue;
3939
import javax.annotation.Nullable;
4040

4141
/**

core/src/main/java/io/grpc/internal/ClientTransportFactory.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818

1919
import com.google.common.base.Objects;
2020
import com.google.common.base.Preconditions;
21+
import com.google.errorprone.annotations.CheckReturnValue;
2122
import io.grpc.Attributes;
2223
import io.grpc.CallCredentials;
2324
import io.grpc.ChannelCredentials;
@@ -27,7 +28,6 @@
2728
import java.net.SocketAddress;
2829
import java.util.Collection;
2930
import java.util.concurrent.ScheduledExecutorService;
30-
import javax.annotation.CheckReturnValue;
3131
import javax.annotation.Nullable;
3232

3333
/** Pre-configured factory for creating {@link ConnectionClientTransport} instances. */

core/src/main/java/io/grpc/internal/DelayedStream.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
import static com.google.common.base.Preconditions.checkState;
2121

2222
import com.google.common.annotations.VisibleForTesting;
23+
import com.google.errorprone.annotations.CheckReturnValue;
2324
import io.grpc.Attributes;
2425
import io.grpc.Compressor;
2526
import io.grpc.Deadline;
@@ -30,7 +31,6 @@
3031
import java.io.InputStream;
3132
import java.util.ArrayList;
3233
import java.util.List;
33-
import javax.annotation.CheckReturnValue;
3434
import javax.annotation.concurrent.GuardedBy;
3535

3636
/**

core/src/main/java/io/grpc/internal/KeepAliveEnforcer.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@
1818

1919
import com.google.common.annotations.VisibleForTesting;
2020
import com.google.common.base.Preconditions;
21+
import com.google.errorprone.annotations.CheckReturnValue;
2122
import java.util.concurrent.TimeUnit;
22-
import javax.annotation.CheckReturnValue;
2323

2424
/** Monitors the client's PING usage to make sure the rate is permitted. */
2525
public final class KeepAliveEnforcer {

core/src/main/java/io/grpc/internal/ManagedClientTransport.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@
1616

1717
package io.grpc.internal;
1818

19+
import com.google.errorprone.annotations.CheckReturnValue;
1920
import io.grpc.Attributes;
2021
import io.grpc.Status;
21-
import javax.annotation.CheckReturnValue;
2222
import javax.annotation.Nullable;
2323
import javax.annotation.concurrent.ThreadSafe;
2424

core/src/main/java/io/grpc/internal/RetriableStream.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222

2323
import com.google.common.annotations.VisibleForTesting;
2424
import com.google.common.base.Objects;
25+
import com.google.errorprone.annotations.CheckReturnValue;
2526
import io.grpc.Attributes;
2627
import io.grpc.ClientStreamTracer;
2728
import io.grpc.Compressor;
@@ -47,7 +48,6 @@
4748
import java.util.concurrent.atomic.AtomicInteger;
4849
import java.util.concurrent.atomic.AtomicLong;
4950
import javax.annotation.CheckForNull;
50-
import javax.annotation.CheckReturnValue;
5151
import javax.annotation.Nullable;
5252
import javax.annotation.concurrent.GuardedBy;
5353

core/src/main/java/io/grpc/internal/TransportFrameUtil.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@
1919
import static java.nio.charset.StandardCharsets.US_ASCII;
2020

2121
import com.google.common.io.BaseEncoding;
22+
import com.google.errorprone.annotations.CheckReturnValue;
2223
import io.grpc.InternalMetadata;
2324
import io.grpc.Metadata;
2425
import java.util.ArrayList;
2526
import java.util.Arrays;
2627
import java.util.List;
2728
import java.util.logging.Logger;
28-
import javax.annotation.CheckReturnValue;
2929

3030
/**
3131
* Utility functions for transport layer framing.

inprocess/src/main/java/io/grpc/inprocess/InProcessTransport.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
import com.google.common.io.ByteStreams;
2525
import com.google.common.util.concurrent.ListenableFuture;
2626
import com.google.common.util.concurrent.SettableFuture;
27+
import com.google.errorprone.annotations.CheckReturnValue;
2728
import io.grpc.Attributes;
2829
import io.grpc.CallOptions;
2930
import io.grpc.ClientStreamTracer;
@@ -74,7 +75,6 @@
7475
import java.util.concurrent.TimeUnit;
7576
import java.util.logging.Level;
7677
import java.util.logging.Logger;
77-
import javax.annotation.CheckReturnValue;
7878
import javax.annotation.Nullable;
7979
import javax.annotation.concurrent.GuardedBy;
8080
import javax.annotation.concurrent.ThreadSafe;

netty/src/main/java/io/grpc/netty/ProtocolNegotiationEvent.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@
2020

2121
import com.google.common.base.MoreObjects;
2222
import com.google.common.base.Objects;
23+
import com.google.errorprone.annotations.CheckReturnValue;
2324
import io.grpc.Attributes;
2425
import io.grpc.Internal;
2526
import io.grpc.InternalChannelz.Security;
26-
import javax.annotation.CheckReturnValue;
2727
import javax.annotation.Nullable;
2828

2929
/**

netty/src/main/java/io/grpc/netty/Utils.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727

2828
import com.google.common.annotations.VisibleForTesting;
2929
import com.google.common.base.Preconditions;
30+
import com.google.errorprone.annotations.CheckReturnValue;
3031
import io.grpc.InternalChannelz;
3132
import io.grpc.InternalMetadata;
3233
import io.grpc.Metadata;
@@ -68,7 +69,6 @@
6869
import java.util.concurrent.TimeUnit;
6970
import java.util.logging.Level;
7071
import java.util.logging.Logger;
71-
import javax.annotation.CheckReturnValue;
7272
import javax.annotation.Nullable;
7373
import javax.net.ssl.SSLException;
7474

netty/src/main/java/io/grpc/netty/package-info.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,5 @@
1818
* The main transport implementation based on <a target="_blank" href="http://netty.io">Netty</a>,
1919
* for both the client and the server.
2020
*/
21-
@javax.annotation.CheckReturnValue
21+
@com.google.errorprone.annotations.CheckReturnValue
2222
package io.grpc.netty;

okhttp/src/main/java/io/grpc/okhttp/OkHttpChannelBuilder.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222

2323
import com.google.common.annotations.VisibleForTesting;
2424
import com.google.common.base.Preconditions;
25+
import com.google.errorprone.annotations.CheckReturnValue;
2526
import io.grpc.CallCredentials;
2627
import io.grpc.ChannelCredentials;
2728
import io.grpc.ChannelLogger;
@@ -72,7 +73,6 @@
7273
import java.util.concurrent.TimeUnit;
7374
import java.util.logging.Level;
7475
import java.util.logging.Logger;
75-
import javax.annotation.CheckReturnValue;
7676
import javax.annotation.Nullable;
7777
import javax.net.SocketFactory;
7878
import javax.net.ssl.HostnameVerifier;

okhttp/src/main/java/io/grpc/okhttp/Utils.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
package io.grpc.okhttp;
1818

1919
import com.google.common.base.Preconditions;
20+
import com.google.errorprone.annotations.CheckReturnValue;
2021
import io.grpc.InternalChannelz;
2122
import io.grpc.InternalMetadata;
2223
import io.grpc.Metadata;
@@ -29,7 +30,6 @@
2930
import java.util.List;
3031
import java.util.logging.Level;
3132
import java.util.logging.Logger;
32-
import javax.annotation.CheckReturnValue;
3333

3434
/**
3535
* Common utility methods for OkHttp transport.

protobuf/BUILD.bazel

+1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ java_library(
1212
"@com_google_protobuf//:protobuf_java",
1313
artifact("com.google.api.grpc:proto-google-common-protos"),
1414
artifact("com.google.code.findbugs:jsr305"),
15+
artifact("com.google.errorprone:error_prone_annotations"),
1516
artifact("com.google.guava:guava"),
1617
],
1718
)

protobuf/src/main/java/io/grpc/protobuf/ProtoMethodDescriptorSupplier.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@
1616

1717
package io.grpc.protobuf;
1818

19+
import com.google.errorprone.annotations.CheckReturnValue;
1920
import com.google.protobuf.Descriptors.MethodDescriptor;
20-
import javax.annotation.CheckReturnValue;
2121

2222
/**
2323
* Provides access to the underlying proto service method descriptor.

rls/BUILD.bazel

+1
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ java_library(
1919
"@io_grpc_grpc_proto//:rls_java_proto",
2020
artifact("com.google.auto.value:auto-value-annotations"),
2121
artifact("com.google.code.findbugs:jsr305"),
22+
artifact("com.google.errorprone:error_prone_annotations"),
2223
artifact("com.google.guava:guava"),
2324
],
2425
)

rls/src/main/java/io/grpc/rls/CachingRlsLbClient.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
import com.google.common.util.concurrent.ListenableFuture;
2929
import com.google.common.util.concurrent.MoreExecutors;
3030
import com.google.common.util.concurrent.SettableFuture;
31+
import com.google.errorprone.annotations.CheckReturnValue;
3132
import io.grpc.ChannelLogger;
3233
import io.grpc.ChannelLogger.ChannelLogLevel;
3334
import io.grpc.ConnectivityState;
@@ -73,7 +74,6 @@
7374
import java.util.concurrent.Future;
7475
import java.util.concurrent.ScheduledExecutorService;
7576
import java.util.concurrent.TimeUnit;
76-
import javax.annotation.CheckReturnValue;
7777
import javax.annotation.Nullable;
7878
import javax.annotation.concurrent.GuardedBy;
7979
import javax.annotation.concurrent.ThreadSafe;

rls/src/main/java/io/grpc/rls/LinkedHashLruCache.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,14 @@
2222

2323
import com.google.common.base.MoreObjects;
2424
import com.google.common.base.Ticker;
25+
import com.google.errorprone.annotations.CheckReturnValue;
2526
import java.util.ArrayList;
2627
import java.util.Collections;
2728
import java.util.Iterator;
2829
import java.util.LinkedHashMap;
2930
import java.util.List;
3031
import java.util.Map;
3132
import java.util.Objects;
32-
import javax.annotation.CheckReturnValue;
3333
import javax.annotation.Nullable;
3434

3535
/**

rls/src/main/java/io/grpc/rls/LruCache.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
package io.grpc.rls;
1818

19-
import javax.annotation.CheckReturnValue;
19+
import com.google.errorprone.annotations.CheckReturnValue;
2020
import javax.annotation.Nullable;
2121

2222
/** An LruCache is a cache with least recently used eviction. */

rls/src/main/java/io/grpc/rls/RlsRequestFactory.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020

2121
import com.google.common.base.MoreObjects;
2222
import com.google.common.collect.ImmutableMap;
23+
import com.google.errorprone.annotations.CheckReturnValue;
2324
import io.grpc.Metadata;
2425
import io.grpc.rls.RlsProtoData.ExtraKeys;
2526
import io.grpc.rls.RlsProtoData.GrpcKeyBuilder;
@@ -30,7 +31,6 @@
3031
import java.util.HashMap;
3132
import java.util.List;
3233
import java.util.Map;
33-
import javax.annotation.CheckReturnValue;
3434

3535
/**
3636
* A RlsRequestFactory creates {@link RouteLookupRequest} using key builder map from {@link

servlet/src/main/java/io/grpc/servlet/AsyncServletOutputStreamWriter.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
import static java.util.logging.Level.FINEST;
2323

2424
import com.google.common.annotations.VisibleForTesting;
25+
import com.google.errorprone.annotations.CheckReturnValue;
2526
import io.grpc.InternalLogId;
2627
import io.grpc.servlet.ServletServerStream.ServletTransportState;
2728
import java.io.IOException;
@@ -34,7 +35,6 @@
3435
import java.util.function.BooleanSupplier;
3536
import java.util.logging.Level;
3637
import java.util.logging.Logger;
37-
import javax.annotation.CheckReturnValue;
3838
import javax.annotation.Nullable;
3939
import javax.servlet.AsyncContext;
4040
import javax.servlet.ServletOutputStream;

0 commit comments

Comments
 (0)