api: Clarify setting safe/idempotent may change other value

This commit is contained in:
Eric Anderson 2019-10-17 07:39:18 -07:00
parent 9a34ceece6
commit 40f401d0e7
1 changed files with 5 additions and 2 deletions

View File

@ -534,7 +534,9 @@ public final class MethodDescriptor<ReqT, RespT> {
/**
* 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 final class MethodDescriptor<ReqT, RespT> {
/**
* 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
*/