Skip to content

Commit d8f434e

Browse files
committed
Document a couple of classes without Javadoc
1 parent 4599563 commit d8f434e

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

src/main/java/com/rabbitmq/client/amqp/AmqpException.java

+8-2
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@ public AmqpException(String message, Throwable cause) {
3232
super(message, cause);
3333
}
3434

35+
/**
36+
* Exception related to connectivity problems.
37+
*/
3538
public static class AmqpConnectionException extends AmqpException {
3639

3740
public AmqpConnectionException(String message, Throwable cause) {
@@ -51,6 +54,9 @@ public AmqpSecurityException(Throwable cause) {
5154
}
5255
}
5356

57+
/**
58+
* Exception thrown when an entity (exchange, queue) does not exit.
59+
*/
5460
public static class AmqpEntityDoesNotExistException extends AmqpException {
5561

5662
public AmqpEntityDoesNotExistException(String message, Throwable cause) {
@@ -63,7 +69,7 @@ public AmqpEntityDoesNotExistException(String message) {
6369
}
6470

6571
/**
66-
* Exception when a resource is not in an appropriate state.
72+
* Exception thrown when a resource is not in an appropriate state.
6773
*
6874
* <p>An example is a connection that is initializing.
6975
*/
@@ -78,7 +84,7 @@ public AmqpResourceInvalidStateException(String message, Throwable cause) {
7884
}
7985
}
8086

81-
/** Exception when a resource is not usable because it is closed. */
87+
/** Exception thrown when a resource is not usable because it is closed. */
8288
public static class AmqpResourceClosedException extends AmqpResourceInvalidStateException {
8389

8490
public AmqpResourceClosedException(String message) {

src/main/java/com/rabbitmq/client/amqp/BackOffDelayPolicy.java

+6
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,9 @@ static BackOffDelayPolicy fixedWithInitialDelay(
7272
return new FixedWithInitialDelayAndTimeoutBackOffPolicy(initialDelay, delay, timeout);
7373
}
7474

75+
/**
76+
* Policy with an initial delay for the first attempt, then a fixed delay.
77+
*/
7578
final class FixedWithInitialDelayBackOffPolicy implements BackOffDelayPolicy {
7679

7780
private final Duration initialDelay;
@@ -98,6 +101,9 @@ public String toString() {
98101
}
99102
}
100103

104+
/**
105+
* Policy with an initial delay for the first attempt, then a fixed delay, and a timeout.
106+
*/
101107
final class FixedWithInitialDelayAndTimeoutBackOffPolicy implements BackOffDelayPolicy {
102108

103109
private final int attemptLimitBeforeTimeout;

0 commit comments

Comments
 (0)