Skip to content

Commit 6f3fdc7

Browse files
artembilanartembilan
committed
Some docs clean up
1 parent db61102 commit 6f3fdc7

23 files changed

+64
-90
lines changed

‎spring-integration-amqp/src/main/java/org/springframework/integration/amqp/channel/AbstractAmqpChannel.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@
3131
import org.springframework.util.Assert;
3232

3333
/**
34+
* The base {@link AbstractMessageChannel} implementation for AMQP.
35+
*
3436
* @author Mark Fisher
3537
* @author Artem Bilan
3638
* @author Gary Russell

‎spring-integration-amqp/src/main/java/org/springframework/integration/amqp/channel/AbstractSubscribableAmqpChannel.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@
4545
import org.springframework.util.Assert;
4646

4747
/**
48+
* The base {@link AbstractAmqpChannel} extension for a {@link SubscribableChannel} contract.
49+
*
4850
* @author Mark Fisher
4951
* @author Gary Russell
5052
* @author Artem Bilan

‎spring-integration-amqp/src/main/java/org/springframework/integration/amqp/channel/PointToPointSubscribableAmqpChannel.java‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,12 @@
2626
import org.springframework.integration.dispatcher.UnicastingDispatcher;
2727

2828
/**
29+
* The {@link AbstractSubscribableAmqpChannel} implementation for one-to-one subscription
30+
* over AMQP queue.
31+
* <p>
32+
* If queue name is not provided, the channel bean name is used internally to declare
33+
* a queue via provided {@link AmqpAdmin} (if any).
34+
*
2935
* @author Mark Fisher
3036
* @author Artem Bilan
3137
*
@@ -45,6 +51,7 @@ public class PointToPointSubscribableAmqpChannel extends AbstractSubscribableAmq
4551
*/
4652
public PointToPointSubscribableAmqpChannel(String channelName, AbstractMessageListenerContainer container,
4753
AmqpTemplate amqpTemplate) {
54+
4855
super(channelName, container, amqpTemplate);
4956
}
5057

@@ -62,6 +69,7 @@ public PointToPointSubscribableAmqpChannel(String channelName, AbstractMessageLi
6269
*/
6370
public PointToPointSubscribableAmqpChannel(String channelName, AbstractMessageListenerContainer container,
6471
AmqpTemplate amqpTemplate, AmqpHeaderMapper outboundMapper, AmqpHeaderMapper inboundMapper) {
72+
6573
super(channelName, container, amqpTemplate, outboundMapper, inboundMapper);
6674
}
6775

‎spring-integration-amqp/src/main/java/org/springframework/integration/amqp/channel/PollableAmqpChannel.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@ public PollableAmqpChannel(String channelName, AmqpTemplate amqpTemplate) {
8787
*/
8888
public PollableAmqpChannel(String channelName, AmqpTemplate amqpTemplate, AmqpHeaderMapper outboundMapper,
8989
AmqpHeaderMapper inboundMapper) {
90+
9091
super(amqpTemplate, outboundMapper, inboundMapper);
9192
Assert.hasText(channelName, "channel name must not be empty");
9293
this.channelName = channelName;

‎spring-integration-amqp/src/main/java/org/springframework/integration/amqp/config/AmqpInboundChannelAdapterParser.java‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,15 @@
2525
import org.springframework.beans.factory.support.BeanDefinitionReaderUtils;
2626
import org.springframework.beans.factory.xml.ParserContext;
2727
import org.springframework.integration.amqp.inbound.AmqpInboundChannelAdapter;
28+
import org.springframework.integration.channel.DirectChannel;
2829
import org.springframework.util.StringUtils;
2930

3031
/**
3132
* Parser for the AMQP 'inbound-channel-adapter' element.
3233
*
3334
* @author Mark Fisher
3435
* @author Gary Russell
36+
* @author Artem Bilan
3537
*
3638
* @since 2.1
3739
*/
@@ -42,7 +44,9 @@ public class AmqpInboundChannelAdapterParser extends AbstractAmqpInboundAdapterP
4244
}
4345

4446
@Override
45-
protected final String resolveId(Element element, AbstractBeanDefinition definition, ParserContext parserContext) throws BeanDefinitionStoreException {
47+
protected final String resolveId(Element element, AbstractBeanDefinition definition, ParserContext parserContext)
48+
throws BeanDefinitionStoreException {
49+
4650
String id = element.getAttribute("id");
4751
if (!element.hasAttribute("channel")) {
4852
// the created channel will get the 'id', so the adapter's bean name includes a suffix
@@ -69,8 +73,7 @@ private String createDirectChannel(Element element, ParserContext parserContext)
6973
parserContext.getReaderContext().error("The channel-adapter's 'id' attribute is required when no 'channel' "
7074
+ "reference has been provided, because that 'id' would be used for the created channel.", element);
7175
}
72-
BeanDefinitionBuilder channelBuilder = BeanDefinitionBuilder.genericBeanDefinition(
73-
"org.springframework.integration.channel.DirectChannel");
76+
BeanDefinitionBuilder channelBuilder = BeanDefinitionBuilder.genericBeanDefinition(DirectChannel.class);
7477
BeanDefinitionHolder holder = new BeanDefinitionHolder(channelBuilder.getBeanDefinition(), channelId);
7578
BeanDefinitionReaderUtils.registerBeanDefinition(holder, parserContext.getRegistry());
7679
return channelId;

‎spring-integration-amqp/src/main/java/org/springframework/integration/amqp/config/AmqpNamespaceHandler.java‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,19 +23,20 @@
2323
*
2424
* @author Mark Fisher
2525
* @author Gary Russell
26+
*
2627
* @since 2.1
2728
*/
2829
public class AmqpNamespaceHandler extends AbstractIntegrationNamespaceHandler {
2930

3031
@Override
3132
public void init() {
32-
this.registerBeanDefinitionParser("channel", new AmqpChannelParser());
33-
this.registerBeanDefinitionParser("publish-subscribe-channel", new AmqpChannelParser());
34-
this.registerBeanDefinitionParser("inbound-channel-adapter", new AmqpInboundChannelAdapterParser());
35-
this.registerBeanDefinitionParser("inbound-gateway", new AmqpInboundGatewayParser());
36-
this.registerBeanDefinitionParser("outbound-channel-adapter", new AmqpOutboundChannelAdapterParser());
37-
this.registerBeanDefinitionParser("outbound-gateway", new AmqpOutboundGatewayParser());
38-
this.registerBeanDefinitionParser("outbound-async-gateway", new AmqpOutboundGatewayParser());
33+
registerBeanDefinitionParser("channel", new AmqpChannelParser());
34+
registerBeanDefinitionParser("publish-subscribe-channel", new AmqpChannelParser());
35+
registerBeanDefinitionParser("inbound-channel-adapter", new AmqpInboundChannelAdapterParser());
36+
registerBeanDefinitionParser("inbound-gateway", new AmqpInboundGatewayParser());
37+
registerBeanDefinitionParser("outbound-channel-adapter", new AmqpOutboundChannelAdapterParser());
38+
registerBeanDefinitionParser("outbound-gateway", new AmqpOutboundGatewayParser());
39+
registerBeanDefinitionParser("outbound-async-gateway", new AmqpOutboundGatewayParser());
3940
}
4041

4142
}

‎spring-integration-amqp/src/main/java/org/springframework/integration/amqp/config/AmqpOutboundChannelAdapterParser.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
* @author Oleg Zhurakousky
3636
* @author Gary Russell
3737
* @author Artem Bilan
38+
*
3839
* @since 2.1
3940
*/
4041
public class AmqpOutboundChannelAdapterParser extends AbstractOutboundChannelAdapterParser {

‎spring-integration-amqp/src/main/java/org/springframework/integration/amqp/dsl/AbstractMessageListenerContainerSpec.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ public S defaultRequeueRejected(boolean defaultRequeueRejected) {
191191
}
192192

193193
/**
194-
* Determine whether or not the container should de-batch batched
194+
* Determine whether the container should de-batch batched
195195
* messages (true) or call the listener with the batch (false). Default: true.
196196
* @param deBatchingEnabled the deBatchingEnabled to set.
197197
* @return the spec.
@@ -300,7 +300,7 @@ public S messagePropertiesConverter(MessagePropertiesConverter messageProperties
300300
}
301301

302302
/**
303-
* If all of the configured queue(s) are not available on the broker, this setting
303+
* If all the configured queue(s) are not available on the broker, this setting
304304
* determines whether the condition is fatal. When true, and
305305
* the queues are missing during startup, the context refresh() will fail.
306306
* <p> When false, the condition is not considered fatal and the container will
@@ -316,7 +316,7 @@ public S missingQueuesFatal(boolean missingQueuesFatal) {
316316

317317
/**
318318
* Prevent the container from starting if any of the queues defined in the context have
319-
* mismatched arguments (TTL etc). Default false.
319+
* mismatched arguments (TTL etc.). Default false.
320320
* @param mismatchedQueuesFatal true to fail initialization when this condition occurs.
321321
* @return the spec.
322322
* @see AbstractMessageListenerContainer#setMismatchedQueuesFatal(boolean)
@@ -329,7 +329,7 @@ public S mismatchedQueuesFatal(boolean mismatchedQueuesFatal) {
329329
/**
330330
* Set to true to automatically declare elements (queues, exchanges, bindings)
331331
* in the application context during container start().
332-
* @param autoDeclare the boolean flag to indicate an declaration operation.
332+
* @param autoDeclare the boolean flag to indicate a declaration operation.
333333
* @return the spec.
334334
* @see AbstractMessageListenerContainer#setAutoDeclare(boolean)
335335
*/

‎spring-integration-amqp/src/main/java/org/springframework/integration/amqp/dsl/Amqp.java‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,9 @@ public static AmqpAsyncOutboundGatewaySpec asyncOutboundGateway(AsyncRabbitTempl
271271
* @param connectionFactory the connectionFactory.
272272
* @return the AmqpPollableMessageChannelSpec.
273273
*/
274-
public static AmqpPollableMessageChannelSpec<?, PollableAmqpChannel> pollableChannel(ConnectionFactory connectionFactory) {
274+
public static AmqpPollableMessageChannelSpec<?, PollableAmqpChannel> pollableChannel(
275+
ConnectionFactory connectionFactory) {
276+
275277
return pollableChannel(null, connectionFactory);
276278
}
277279

@@ -284,7 +286,8 @@ public static AmqpPollableMessageChannelSpec<?, PollableAmqpChannel> pollableCha
284286
public static AmqpPollableMessageChannelSpec<?, PollableAmqpChannel> pollableChannel(@Nullable String id,
285287
ConnectionFactory connectionFactory) {
286288

287-
AmqpPollableMessageChannelSpec<?, PollableAmqpChannel> spec = new AmqpPollableMessageChannelSpec<>(connectionFactory);
289+
AmqpPollableMessageChannelSpec<?, PollableAmqpChannel> spec =
290+
new AmqpPollableMessageChannelSpec<>(connectionFactory);
288291
return spec.id(id);
289292
}
290293

‎spring-integration-amqp/src/main/java/org/springframework/integration/amqp/outbound/AbstractAmqpOutboundEndpoint.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@
5454
import org.springframework.util.concurrent.SettableListenableFuture;
5555

5656
/**
57+
* A base {@link AbstractReplyProducingMessageHandler} extension for AMQP message handlers.
58+
*
5759
* @author Gary Russell
5860
* @author Artem Bilan
5961
*

0 commit comments

Comments
 (0)