Skip to content

Commit 57c79dd

Browse files
[service bus] Terminology clarification and small copy/paste errors in javadocs (Azure#17691)
1 parent 7cd22b4 commit 57c79dd

File tree

4 files changed

+27
-26
lines changed

4 files changed

+27
-26
lines changed

sdk/servicebus/azure-messaging-servicebus/src/main/java/com/azure/messaging/servicebus/ServiceBusClientBuilder.java

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -277,7 +277,7 @@ public ServiceBusSenderClientBuilder sender() {
277277
}
278278

279279
/**
280-
* A new instance of {@link ServiceBusReceiverClientBuilder} used to configure Service Bus message consumers.
280+
* A new instance of {@link ServiceBusReceiverClientBuilder} used to configure Service Bus message receivers.
281281
*
282282
* @return A new instance of {@link ServiceBusReceiverClientBuilder}.
283283
*/
@@ -287,7 +287,7 @@ public ServiceBusReceiverClientBuilder receiver() {
287287

288288
/**
289289
* A new instance of {@link ServiceBusSessionReceiverClientBuilder} used to configure <b>session aware</b> Service
290-
* Bus message consumers.
290+
* Bus message receivers.
291291
*
292292
* @return A new instance of {@link ServiceBusSessionReceiverClientBuilder}.
293293
*/
@@ -788,9 +788,9 @@ public ServiceBusSessionProcessorClientBuilder disableAutoComplete() {
788788

789789
/**
790790
* Creates a <b>session-aware</b> Service Bus processor responsible for reading
791-
* {@link ServiceBusReceivedMessage messages} from a specific queue or topic.
791+
* {@link ServiceBusReceivedMessage messages} from a specific queue or subscription.
792792
*
793-
* @return An new {@link ServiceBusProcessorClient} that receives messages from a queue or topic.
793+
* @return An new {@link ServiceBusProcessorClient} that receives messages from a queue or subscription.
794794
* @throws IllegalStateException if {@link #queueName(String) queueName} or {@link #topicName(String)
795795
* topicName} are not set or, both of these fields are set. It is also thrown if the Service Bus {@link
796796
* #connectionString(String) connectionString} contains an {@code EntityPath} that does not match one set in
@@ -950,9 +950,9 @@ public ServiceBusSessionReceiverClientBuilder topicName(String topicName) {
950950

951951
/**
952952
* Creates an <b>asynchronous</b>, <b>session-aware</b> Service Bus receiver responsible for reading {@link
953-
* ServiceBusMessage messages} from a specific queue or topic.
953+
* ServiceBusMessage messages} from a specific queue or subscription.
954954
*
955-
* @return An new {@link ServiceBusReceiverAsyncClient} that receives messages from a queue or topic.
955+
* @return An new {@link ServiceBusReceiverAsyncClient} that receives messages from a queue or subscription.
956956
* @throws IllegalStateException if {@link #queueName(String) queueName} or {@link #topicName(String)
957957
* topicName} are not set or, both of these fields are set. It is also thrown if the Service Bus {@link
958958
* #connectionString(String) connectionString} contains an {@code EntityPath} that does not match one set in
@@ -967,9 +967,9 @@ ServiceBusReceiverAsyncClient buildAsyncClientForProcessor() {
967967

968968
/**
969969
* Creates a <b>synchronous</b>, <b>session-aware</b> Service Bus receiver responsible for reading {@link
970-
* ServiceBusMessage messages} from a specific queue or topic.
970+
* ServiceBusMessage messages} from a specific queue or subscription.
971971
*
972-
* @return An new {@link ServiceBusReceiverClient} that receives messages from a queue or topic.
972+
* @return An new {@link ServiceBusReceiverClient} that receives messages from a queue or subscription.
973973
* @throws IllegalStateException if {@link #queueName(String) queueName} or {@link #topicName(String)
974974
* topicName} are not set or, both of these fields are set. It is also thrown if the Service Bus {@link
975975
* #connectionString(String) connectionString} contains an {@code EntityPath} that does not match one set in
@@ -1017,9 +1017,10 @@ private ServiceBusReceiverAsyncClient buildAsyncClientForProcessor(boolean isAut
10171017

10181018
/**
10191019
* Creates an <b>asynchronous</b>, <b>session-aware</b> Service Bus receiver responsible for reading {@link
1020-
* ServiceBusMessage messages} from a specific queue or topic.
1020+
* ServiceBusMessage messages} from a specific queue or subscription.
10211021
*
1022-
* @return An new {@link ServiceBusSessionReceiverAsyncClient} that receives messages from a queue or topic.
1022+
* @return An new {@link ServiceBusSessionReceiverAsyncClient} that receives messages from a queue or
1023+
* subscription.
10231024
* @throws IllegalStateException if {@link #queueName(String) queueName} or {@link #topicName(String)
10241025
* topicName} are not set or, both of these fields are set. It is also thrown if the Service Bus {@link
10251026
* #connectionString(String) connectionString} contains an {@code EntityPath} that does not match one set in
@@ -1034,9 +1035,9 @@ public ServiceBusSessionReceiverAsyncClient buildAsyncClient() {
10341035

10351036
/**
10361037
* Creates a <b>synchronous</b>, <b>session-aware</b> Service Bus receiver responsible for reading {@link
1037-
* ServiceBusMessage messages} from a specific queue or topic.
1038+
* ServiceBusMessage messages} from a specific queue or subscription.
10381039
*
1039-
* @return An new {@link ServiceBusReceiverClient} that receives messages from a queue or topic.
1040+
* @return An new {@link ServiceBusReceiverClient} that receives messages from a queue or subscription.
10401041
* @throws IllegalStateException if {@link #queueName(String) queueName} or {@link #topicName(String)
10411042
* topicName} are not set or, both of these fields are set. It is also thrown if the Service Bus {@link
10421043
* #connectionString(String) connectionString} contains an {@code EntityPath} that does not match one set in
@@ -1222,9 +1223,9 @@ public ServiceBusProcessorClientBuilder disableAutoComplete() {
12221223

12231224
/**
12241225
* Creates Service Bus message processor responsible for reading {@link ServiceBusReceivedMessage
1225-
* messages} from a specific queue or topic.
1226+
* messages} from a specific queue or subscription.
12261227
*
1227-
* @return An new {@link ServiceBusProcessorClient} that processes messages from a queue or topic.
1228+
* @return An new {@link ServiceBusProcessorClient} that processes messages from a queue or subscription.
12281229
* @throws IllegalStateException if {@link #queueName(String) queueName} or {@link #topicName(String)
12291230
* topicName} are not set or, both of these fields are set. It is also thrown if the Service Bus {@link
12301231
* #connectionString(String) connectionString} contains an {@code EntityPath} that does not match one set in
@@ -1379,9 +1380,9 @@ public ServiceBusReceiverClientBuilder topicName(String topicName) {
13791380

13801381
/**
13811382
* Creates an <b>asynchronous</b> Service Bus receiver responsible for reading {@link ServiceBusMessage
1382-
* messages} from a specific queue or topic.
1383+
* messages} from a specific queue or subscription.
13831384
*
1384-
* @return An new {@link ServiceBusReceiverAsyncClient} that receives messages from a queue or topic.
1385+
* @return An new {@link ServiceBusReceiverAsyncClient} that receives messages from a queue or subscription.
13851386
* @throws IllegalStateException if {@link #queueName(String) queueName} or {@link #topicName(String)
13861387
* topicName} are not set or, both of these fields are set. It is also thrown if the Service Bus {@link
13871388
* #connectionString(String) connectionString} contains an {@code EntityPath} that does not match one set in
@@ -1396,9 +1397,9 @@ public ServiceBusReceiverAsyncClient buildAsyncClient() {
13961397

13971398
/**
13981399
* Creates <b>synchronous</b> Service Bus receiver responsible for reading {@link ServiceBusMessage messages}
1399-
* from a specific queue or topic.
1400+
* from a specific queue or subscription.
14001401
*
1401-
* @return An new {@link ServiceBusReceiverClient} that receives messages from a queue or topic.
1402+
* @return An new {@link ServiceBusReceiverClient} that receives messages from a queue or subscription.
14021403
* @throws IllegalStateException if {@link #queueName(String) queueName} or {@link #topicName(String)
14031404
* topicName} are not set or, both of these fields are set. It is also thrown if the Service Bus {@link
14041405
* #connectionString(String) connectionString} contains an {@code EntityPath} that does not match one set in

sdk/servicebus/azure-messaging-servicebus/src/main/java/com/azure/messaging/servicebus/models/AbandonOptions.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ public final class AbandonOptions extends SettlementOptions {
1414
private Map<String, Object> propertiesToModify;
1515

1616
/**
17-
* Gets the message properties to modify while putting put message in dead letter sub-queue.
17+
* Gets the message properties to modify while abandoning the message.
1818
*
19-
* @return The message properties to modify while putting message in dead letter sub-queue.
19+
* @return The message properties to modify while abandoning the message.
2020
*/
2121
public Map<String, Object> getPropertiesToModify() {
2222
return propertiesToModify;

sdk/servicebus/azure-messaging-servicebus/src/main/java/com/azure/messaging/servicebus/models/DeferOptions.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ public final class DeferOptions extends SettlementOptions {
1414
private Map<String, Object> propertiesToModify;
1515

1616
/**
17-
* Sets the message properties to modify while abandoning message.
17+
* Sets the message properties to modify while deferring the message.
1818
*
1919
* @param propertiesToModify Message properties to modify.
2020
*
@@ -26,9 +26,9 @@ public DeferOptions setPropertiesToModify(Map<String, Object> propertiesToModify
2626
}
2727

2828
/**
29-
* Gets the message properties to modify while putting put message in dead letter sub-queue.
29+
* Gets the message properties to modify while deferring the message.
3030
*
31-
* @return The message properties to modify while putting message in dead letter sub-queue.
31+
* @return The message properties to modify while deferring the message.
3232
*/
3333
public Map<String, Object> getPropertiesToModify() {
3434
return propertiesToModify;

sdk/servicebus/azure-messaging-servicebus/src/main/java/com/azure/messaging/servicebus/models/SubQueue.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
import com.azure.messaging.servicebus.ServiceBusReceiverClient;
88

99
/**
10-
* Azure Service Bus queues and topic subscriptions provide a secondary subqueue, called a dead-letter queue (DLQ).
10+
* Azure Service Bus queues and subscriptions provide a secondary subqueue, called a dead-letter queue (DLQ).
1111
* The dead-letter queue doesn't need to be explicitly created and can't be deleted or otherwise managed
1212
* independent of the main entity.
1313
*
@@ -20,15 +20,15 @@ public enum SubQueue {
2020
NONE,
2121

2222
/**
23-
* This value to indicate dead-letter queue.
23+
* Connect to a queue or subscription's dead-letter queue.
2424
* <p>
2525
* This is builder for creating {@link ServiceBusReceiverClient} and {@link ServiceBusReceiverAsyncClient} to
2626
* consume dead-letter messages from Service Bus entity.
2727
*/
2828
DEAD_LETTER_QUEUE,
2929

3030
/**
31-
* This value to indicate transfer dead-letter queue.
31+
* Connect to a queue or subscription's transfer dead-letter queue.
3232
*<p>
3333
* This is builder for creating {@link ServiceBusReceiverClient} and {@link ServiceBusReceiverAsyncClient} to
3434
* consume transfer dead-letter messages from Service Bus entity.

0 commit comments

Comments
 (0)