Skip to content

Commit 37f78bf

Browse files
committed
Improve javadocs for the class and methods
1 parent 177e6ca commit 37f78bf

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

core/sdk-core/src/main/java/software/amazon/awssdk/core/exception/SdkServiceException.java

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,6 @@
2929
* reason, the service was not able to process it, and returned an error
3030
* response instead.
3131
* <p>
32-
* Exceptions that extend {@link SdkServiceException} are assumed to be able to be
33-
* successfully retried.
34-
* <p>
3532
* SdkServiceException provides callers several pieces of information that can
3633
* be used to obtain more information about the error and why it occurred.
3734
*
@@ -83,18 +80,23 @@ public boolean isClockSkewException() {
8380
}
8481

8582
/**
86-
* Specifies whether an exception is caused by throttling.
83+
* Specifies whether an exception is caused by throttling. This method by default returns {@code true} if the status code is
84+
* equal to <a href="https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#429">429 Too Many Requests</a>
85+
* but subclasses can override this method to signal that the specific subclass is considered a throttling exception.
8786
*
88-
* @return true if the status code is 429, otherwise false.
87+
* @return true if the exception is classified as throttling, otherwise false.
88+
* @see #isRetryableException()
8989
*/
9090
public boolean isThrottlingException() {
9191
return statusCode == HttpStatusCode.THROTTLING;
9292
}
9393

9494
/**
95-
* Specifies whether an exception is retryable.
95+
* Specifies whether an exception is retryable. This method by default returns {@code false} but subclasses can override this
96+
* value to signal that the specific subclass is retryable.
9697
*
97-
* @return true if the exception is classified as retryable.
98+
* @return true if the exception is classified as retryable, otherwise false.
99+
* @see #isThrottlingException()
98100
*/
99101
public boolean isRetryableException() {
100102
return false;

0 commit comments

Comments
 (0)