api: Clarify setting safe/idempotent may change other value

nterry · Oct 17, 2019 · 40f401d · 40f401d
1 parent 9a34cee
commit 40f401d
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/api/src/main/java/io/grpc/MethodDescriptor.java b/api/src/main/java/io/grpc/MethodDescriptor.java
@@ -534,7 +534,9 @@ public Builder<ReqT, RespT> setSchemaDescriptor(@Nullable Object schemaDescripto
 
     /**
      * Sets whether the method is idempotent.  If true, calling this method more than once doesn't
-     * have additional side effects. If {@code false}, method is also not safe.
+     * have additional side effects. If {@code false}, method is also not safe. Note that implies
+     * calling {@code builder.setIdempotent(false).setIdempotent(true)} will leave {@code
+     * isSafe() == false}.
      *
      * @since 1.1.0
      */
@@ -549,7 +551,8 @@ public Builder<ReqT, RespT> setIdempotent(boolean idempotent) {
 
     /**
      * Sets whether this method is safe.  If true, calling this method any number of times doesn't
-     * have side effects. If {@code true}, method is also idempotent.
+     * have side effects. If {@code true}, method is also idempotent. Note that implies calling
+     * {@code builder.setSafe(true).setSafe(false)} will leave {@code isIdempotent() == true}.
      *
      * @since 1.1.0
      */