diff options
author | Carl Mastrangelo <notcarl@google.com> | 2018-07-31 15:28:48 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-07-31 15:28:48 -0700 |
commit | 85448189ee23380d8f01ef774f070becd0744677 (patch) | |
tree | 2aeb977b144cdcb05c07031470492a95f58f907e /core | |
parent | 696082f52ebad64bcc89dee5dc1d02b10965cfcf (diff) | |
download | grpc-grpc-java-85448189ee23380d8f01ef774f070becd0744677.tar.gz |
all: add tracking issues for all experimental APIs and make it required
Additionally, make Status*Exception.getTrailers() non experimental
Diffstat (limited to 'core')
-rw-r--r-- | core/src/main/java/io/grpc/ExperimentalApi.java | 2 | ||||
-rw-r--r-- | core/src/main/java/io/grpc/Metadata.java | 2 | ||||
-rw-r--r-- | core/src/main/java/io/grpc/SecurityLevel.java | 2 | ||||
-rw-r--r-- | core/src/main/java/io/grpc/Status.java | 2 | ||||
-rw-r--r-- | core/src/main/java/io/grpc/StatusException.java | 12 | ||||
-rw-r--r-- | core/src/main/java/io/grpc/StatusRuntimeException.java | 12 |
6 files changed, 26 insertions, 6 deletions
diff --git a/core/src/main/java/io/grpc/ExperimentalApi.java b/core/src/main/java/io/grpc/ExperimentalApi.java index 22eef51fc..3ad54b21b 100644 --- a/core/src/main/java/io/grpc/ExperimentalApi.java +++ b/core/src/main/java/io/grpc/ExperimentalApi.java @@ -53,5 +53,5 @@ public @interface ExperimentalApi { /** * Context information such as links to discussion thread, tracking issue etc. */ - String value() default ""; + String value(); } diff --git a/core/src/main/java/io/grpc/Metadata.java b/core/src/main/java/io/grpc/Metadata.java index 7f4393fcb..93f0347d3 100644 --- a/core/src/main/java/io/grpc/Metadata.java +++ b/core/src/main/java/io/grpc/Metadata.java @@ -366,7 +366,7 @@ public final class Metadata { * Remove all values for the given key without returning them. This is a minor performance * optimization if you do not need the previous values. */ - @ExperimentalApi + @ExperimentalApi("https://github.com/grpc/grpc-java/issues/4691") public <T> void discardAll(Key<T> key) { if (isEmpty()) { return; diff --git a/core/src/main/java/io/grpc/SecurityLevel.java b/core/src/main/java/io/grpc/SecurityLevel.java index 9ce57ebbb..7d834aadb 100644 --- a/core/src/main/java/io/grpc/SecurityLevel.java +++ b/core/src/main/java/io/grpc/SecurityLevel.java @@ -19,7 +19,7 @@ package io.grpc; /** * The level of security guarantee in communications. */ -@ExperimentalApi +@ExperimentalApi("https://github.com/grpc/grpc-java/issues/4692") public enum SecurityLevel { /** * No security guarantee. diff --git a/core/src/main/java/io/grpc/Status.java b/core/src/main/java/io/grpc/Status.java index 9f5b351ef..8554f17c4 100644 --- a/core/src/main/java/io/grpc/Status.java +++ b/core/src/main/java/io/grpc/Status.java @@ -408,7 +408,7 @@ public final class Status { * * @return the trailers or {@code null} if not found. */ - @ExperimentalApi + @ExperimentalApi("https://github.com/grpc/grpc-java/issues/4683") public static Metadata trailersFromThrowable(Throwable t) { Throwable cause = checkNotNull(t, "t"); while (cause != null) { diff --git a/core/src/main/java/io/grpc/StatusException.java b/core/src/main/java/io/grpc/StatusException.java index 7c48d8961..f9416bf72 100644 --- a/core/src/main/java/io/grpc/StatusException.java +++ b/core/src/main/java/io/grpc/StatusException.java @@ -28,6 +28,11 @@ public class StatusException extends Exception { private final Status status; private final Metadata trailers; + /** + * Constructs an exception with both a status. See also {@link Status#asException()}. + * + * @since 1.0.0 + */ public StatusException(Status status) { this(status, null); } @@ -35,6 +40,8 @@ public class StatusException extends Exception { /** * Constructs an exception with both a status and trailers. See also * {@link Status#asException(Metadata)}. + * + * @since 1.0.0 */ public StatusException(Status status, @Nullable Metadata trailers) { super(Status.formatThrowableMessage(status), status.getCause()); @@ -44,6 +51,8 @@ public class StatusException extends Exception { /** * Returns the status code as a {@link Status} object. + * + * @since 1.0.0 */ public final Status getStatus() { return status; @@ -51,8 +60,9 @@ public class StatusException extends Exception { /** * Returns the received trailers. + * + * @since 1.0.0 */ - @ExperimentalApi public final Metadata getTrailers() { return trailers; } diff --git a/core/src/main/java/io/grpc/StatusRuntimeException.java b/core/src/main/java/io/grpc/StatusRuntimeException.java index 3d032a7aa..d685464d4 100644 --- a/core/src/main/java/io/grpc/StatusRuntimeException.java +++ b/core/src/main/java/io/grpc/StatusRuntimeException.java @@ -29,6 +29,11 @@ public class StatusRuntimeException extends RuntimeException { private final Status status; private final Metadata trailers; + /** + * Constructs the exception with both a status. See also {@link Status#asException()}. + * + * @since 1.0.0 + */ public StatusRuntimeException(Status status) { this(status, null); } @@ -36,6 +41,8 @@ public class StatusRuntimeException extends RuntimeException { /** * Constructs the exception with both a status and trailers. See also * {@link Status#asException(Metadata)}. + * + * @since 1.0.0 */ public StatusRuntimeException(Status status, @Nullable Metadata trailers) { super(Status.formatThrowableMessage(status), status.getCause()); @@ -45,6 +52,8 @@ public class StatusRuntimeException extends RuntimeException { /** * Returns the status code as a {@link Status} object. + * + * @since 1.0.0 */ public final Status getStatus() { return status; @@ -52,8 +61,9 @@ public class StatusRuntimeException extends RuntimeException { /** * Returns the received trailers. + * + * @since 1.0.0 */ - @ExperimentalApi public final Metadata getTrailers() { return trailers; } |