Skip to content

Commit 6f98cf3

Browse files
committed
Explicit documentation on 4.1+ properties in AbstractMessageListenerContainer
1 parent 4f1d9fd commit 6f98cf3

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

spring-jms/src/main/java/org/springframework/jms/listener/AbstractMessageListenerContainer.java

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,8 +131,8 @@
131131
* @see SimpleMessageListenerContainer
132132
* @see org.springframework.jms.listener.endpoint.JmsMessageEndpointManager
133133
*/
134-
public abstract class AbstractMessageListenerContainer
135-
extends AbstractJmsListeningContainer implements MessageListenerContainer {
134+
public abstract class AbstractMessageListenerContainer extends AbstractJmsListeningContainer
135+
implements MessageListenerContainer {
136136

137137
private static final Method createSharedConsumerMethod = ClassUtils.getMethodIfAvailable(
138138
Session.class, "createSharedConsumer", Topic.class, String.class, String.class);
@@ -354,6 +354,7 @@ public boolean isSubscriptionDurable() {
354354
* <p>Only makes sense when listening to a topic (pub-sub domain),
355355
* therefore this method switches the "pubSubDomain" flag as well.
356356
* <p><b>Requires a JMS 2.0 compatible message broker.</b>
357+
* @since 4.1
357358
* @see #setSubscriptionName
358359
* @see #setSubscriptionDurable
359360
* @see #setPubSubDomain
@@ -367,6 +368,7 @@ public void setSubscriptionShared(boolean subscriptionShared) {
367368

368369
/**
369370
* Return whether to make the subscription shared.
371+
* @since 4.1
370372
*/
371373
public boolean isSubscriptionShared() {
372374
return this.subscriptionShared;
@@ -380,6 +382,7 @@ public boolean isSubscriptionShared() {
380382
* <p>Note: Only 1 concurrent consumer (which is the default of this
381383
* message listener container) is allowed for each subscription,
382384
* except for a shared subscription (which requires JMS 2.0).
385+
* @since 4.1
383386
* @see #setPubSubDomain
384387
* @see #setSubscriptionDurable
385388
* @see #setSubscriptionShared
@@ -390,6 +393,10 @@ public void setSubscriptionName(String subscriptionName) {
390393
this.subscriptionName = subscriptionName;
391394
}
392395

396+
/**
397+
* Return the name of a subscription to create, if any.
398+
* @since 4.1
399+
*/
393400
public String getSubscriptionName() {
394401
return this.subscriptionName;
395402
}
@@ -423,6 +430,7 @@ public String getDurableSubscriptionName() {
423430
/**
424431
* Set whether to inhibit the delivery of messages published by its own connection.
425432
* Default is "false".
433+
* @since 4.1
426434
* @see javax.jms.Session#createConsumer(javax.jms.Destination, String, boolean)
427435
*/
428436
public void setPubSubNoLocal(boolean pubSubNoLocal) {
@@ -431,13 +439,15 @@ public void setPubSubNoLocal(boolean pubSubNoLocal) {
431439

432440
/**
433441
* Return whether to inhibit the delivery of messages published by its own connection.
442+
* @since 4.1
434443
*/
435444
public boolean isPubSubNoLocal() {
436445
return this.pubSubNoLocal;
437446
}
438447

439448
/**
440449
* Set the {@link MessageConverter} strategy for converting JMS Messages.
450+
* @since 4.1
441451
*/
442452
public void setMessageConverter(MessageConverter messageConverter) {
443453
this.messageConverter = messageConverter;
@@ -477,6 +487,7 @@ public void setErrorHandler(ErrorHandler errorHandler) {
477487
/**
478488
* Return the ErrorHandler to be invoked in case of any uncaught exceptions thrown
479489
* while processing a Message.
490+
* @since 4.1
480491
*/
481492
public ErrorHandler getErrorHandler() {
482493
return this.errorHandler;

0 commit comments

Comments
 (0)