Skip to content

Commit e2d177e

Browse files
committed
Fix "One sentence per line" in docs
1 parent d56e29b commit e2d177e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+190
-124
lines changed

src/reference/asciidoc/aggregator.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,8 @@ However if, for some reason, you need to access the full `MessageGroup`, you sho
188188
When handling potentially large groups, you should understand how these methods are invoked, because the release strategy may be invoked multiple times before the group is released.
189189
The most efficient is an implementation of `ReleaseStrategy`, because the aggregator can invoke it directly.
190190
The second most efficient is a POJO method with a `Collection<Message<?>>` parameter type.
191-
The least efficient is a POJO method with a `Collection<Something>` type. The framework has to copy the payloads from the messages in the group into a new collection (and possibly attempt conversion on the payloads to `Something`) every time the release strategy is called.
191+
The least efficient is a POJO method with a `Collection<Something>` type.
192+
The framework has to copy the payloads from the messages in the group into a new collection (and possibly attempt conversion on the payloads to `Something`) every time the release strategy is called.
192193
Using `Collection<?>` avoids the conversion but still requires creating the new `Collection`.
193194
194195
For these reasons, for large groups, we recommended that you implement `ReleaseStrategy`.
@@ -597,7 +598,8 @@ Since Spring Integration 2.0, you can handle the various strategies (correlation
597598
Suppose you have a legacy component that was designed to receive an array of objects.
598599
We know that the default release strategy assembles all aggregated messages in the `List`.
599600
Now we have two problems.
600-
First, we need to extract individual messages from the list. Second, we need to extract the payload of each message and assemble the array of objects.
601+
First, we need to extract individual messages from the list.
602+
Second, we need to extract the payload of each message and assemble the array of objects.
601603
The following example solves both problems:
602604
603605
====

src/reference/asciidoc/amqp.adoc

Lines changed: 15 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -551,16 +551,14 @@ If that is not customized at all, the default is `PERSISTENT`.
551551
Optional.
552552
<10> An expression that defines correlation data.
553553
When provided, this configures the underlying AMQP template to receive publisher confirmations.
554-
Requires a dedicated `RabbitTemplate` and a `CachingConnectionFactory` with the `publisherConfirms` property set to
555-
`true`. When a publisher confirmation is received and correlation data is supplied, it is written to either the
556-
`confirm-ack-channel` or the `confirm-nack-channel`, depending on the confirmation type. The payload of the confirmation is
557-
the correlation data, as defined by this expression.
554+
Requires a dedicated `RabbitTemplate` and a `CachingConnectionFactory` with the `publisherConfirms` property set to `true`.
555+
When a publisher confirmation is received and correlation data is supplied, it is written to either the `confirm-ack-channel` or the `confirm-nack-channel`, depending on the confirmation type.
556+
The payload of the confirmation is the correlation data, as defined by this expression.
558557
The message has an 'amqp_publishConfirm' header set to `true` (`ack`) or `false` (`nack`).
559558
Examples: `headers['myCorrelationData']` and `payload`.
560559
Version 4.1 introduced the `amqp_publishConfirmNackCause` message header.
561560
It contains the `cause` of a 'nack' for a publisher confirmation.
562-
Starting with version 4.2, if the expression resolves to a `Message<?>` instance (such as `#this`), the message
563-
emitted on the `ack`/`nack` channel is based on that message, with the additional header(s) added.
561+
Starting with version 4.2, if the expression resolves to a `Message<?>` instance (such as `#this`), the message emitted on the `ack`/`nack` channel is based on that message, with the additional header(s) added.
564562
Previously, a new message was created with the correlation data as its payload, regardless of type.
565563
Optional.
566564
<11> The channel to which positive (`ack`) publisher confirms are sent.
@@ -964,28 +962,25 @@ If that is not customized, the default is `PERSISTENT`.
964962
Optional.
965963
<13> An expression that defines correlation data.
966964
When provided, this configures the underlying AMQP template to receive publisher confirmations.
967-
Requires a dedicated `RabbitTemplate` and a `CachingConnectionFactory` with its `publisherConfirms` property set to
968-
`true`. When a publisher confirmation is received and correlation data is supplied, the confirmation is written to either the
969-
`confirm-ack-channel` or the `confirm-nack-channel`, depending on the confirmation type. The payload of the confirmation is
970-
the correlation data as defined by this expression, and the message has its 'amqp_publishConfirm' header set to `true`
971-
(`ack`) or `false` (`nack`).
965+
Requires a dedicated `RabbitTemplate` and a `CachingConnectionFactory` with its `publisherConfirms` property set to `true`.
966+
When a publisher confirmation is received and correlation data is supplied, the confirmation is written to either the `confirm-ack-channel` or the `confirm-nack-channel`, depending on the confirmation type.
967+
The payload of the confirmation is the correlation data as defined by this expression, and the message has its 'amqp_publishConfirm' header set to `true` (`ack`) or `false` (`nack`).
972968
For `nack` instances, an additional header (`amqp_publishConfirmNackCause`) is provided.
973969
Examples: `headers['myCorrelationData']`, `payload`.
974-
If the expression resolves to a `Message<?>` instance (such as "`#this`"), the message
975-
emitted on the `ack`/`nack` channel is based on that message, with the additional headers added.
970+
If the expression resolves to a `Message<?>` instance (such as "`#this`"), the message emitted on the `ack`/`nack` channel is based on that message, with the additional headers added.
976971
Optional.
977972
<14> The channel to which positive (`ack`) publisher confirmations are sent.
978973
The payload is the correlation data defined by the `confirm-correlation-expression`.
979974
Requires the underlying `AsyncRabbitTemplate` to have its `enableConfirms` property set to `true`.
980975
Optional (the default is `nullChannel`).
981-
<15> Since version 4.2. The channel to which negative (`nack`) publisher confirmations are sent.
976+
<15> Since version 4.2.
977+
The channel to which negative (`nack`) publisher confirmations are sent.
982978
The payload is the correlation data defined by the `confirm-correlation-expression`.
983979
Requires the underlying `AsyncRabbitTemplate` to have its `enableConfirms` property set to `true`.
984980
Optional (the default is `nullChannel`).
985981
<16> The channel to which returned messages are sent.
986982
When provided, the underlying AMQP template is configured to return undeliverable messages to the gateway.
987-
The message is constructed from the data received from AMQP, with the following additional headers:
988-
`amqp_returnReplyCode`, `amqp_returnReplyText`, `amqp_returnExchange`, and `amqp_returnRoutingKey`.
983+
The message is constructed from the data received from AMQP, with the following additional headers: `amqp_returnReplyCode`, `amqp_returnReplyText`, `amqp_returnExchange`, and `amqp_returnRoutingKey`.
989984
Requires the underlying `AsyncRabbitTemplate` to have its `mandatory` property set to `true`.
990985
Optional.
991986
<17> When set to `false`, the endpoint tries to connect to the broker during application context initialization.
@@ -1391,13 +1386,11 @@ It also does not map the `deliveryMode` to the `amqp_deliveryMode` header, to av
13911386
Instead, this header is mapped to `amqp_receivedDeliveryMode`, which is not mapped on output.
13921387

13931388
Starting with version 4.3, patterns in the header mappings can be negated by preceding the pattern with `!`.
1394-
Negated patterns get priority, so a list such as
1395-
`STANDARD_REQUEST_HEADERS,thing1,ba*,!thing2,!thing3,qux,!thing1` does not map `thing1`
1396-
(nor `thing2` nor `thing3`).
1389+
Negated patterns get priority, so a list such as `STANDARD_REQUEST_HEADERS,thing1,ba*,!thing2,!thing3,qux,!thing1` does not map `thing1` (nor `thing2` nor `thing3`).
13971390
The standard headers plus `bad` and `qux` are mapped.
13981391

1399-
IMPORTANT: If you have a user-defined header that begins with `!` that you do wish to map, you need to escape it with
1400-
`\`, as follows: `STANDARD_REQUEST_HEADERS,\!myBangHeader`. The header named `!myBangHeader` is now mapped.
1392+
IMPORTANT: If you have a user-defined header that begins with `!` that you do wish to map, you need to escape it with `\`, as follows: `STANDARD_REQUEST_HEADERS,\!myBangHeader`.
1393+
The header named `!myBangHeader` is now mapped.
14011394

14021395
NOTE: Starting with _version 5.1_, the `DefaultAmqpHeaderMapper` will fall back to mapping `MessageHeaders.ID` and `MessageHeaders.TIMESTAMP` to `MessageProperties.messageId` and `MessageProperties.timestamp` respectively, if the corresponding `amqp_messageId` or `amqp_timestamp` headers are not present on outbound messages.
14031396
Inbound properties will be mapped to the `amqp_*` headers as before.
@@ -1407,7 +1400,7 @@ It is useful to populate the `messageId` property when message consumers are usi
14071400
==== contentType Header
14081401

14091402
Unlike other headers, the `AmqpHeaders.CONTENT_TYPE` is not prefixed with `amqp_`; this allows transparent passing of the contentType header across different technologies.
1410-
E.g. an inbound HTTP message sent to a RabbitMQ queue.
1403+
For example an inbound HTTP message sent to a RabbitMQ queue.
14111404

14121405
The `contentType` header is mapped to Spring AMQP's `MessageProperties.contentType` property and that is subsequently mapped to RabbitMQ's `content_type` property.
14131406

src/reference/asciidoc/changes-1.0-2.0.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,8 @@ See <<feed>> for more details.
118118

119119
[[new-other]]
120120
==== Other Additions
121-
Spring Integration adds a number of other features. This section describes them.
121+
Spring Integration adds a number of other features.
122+
This section describes them.
122123

123124
[[new-groovy]]
124125
===== Groovy Support
@@ -165,7 +166,8 @@ We have also switched our build system to http://gradle.org/[Gradle].
165166
==== New Spring Integration Samples
166167

167168
With Spring Integration 2.0, we have decoupled the samples from our main release distribution.
168-
Please read the following blog to get more information: http://blog.springsource.com/2010/09/29/new-spring-integration-samples/[New Spring Integration Samples]. We have also created many new samples, including samples for every new adapter.
169+
Please read the following blog to get more information: http://blog.springsource.com/2010/09/29/new-spring-integration-samples/[New Spring Integration Samples].
170+
We have also created many new samples, including samples for every new adapter.
169171

170172
[[new-sts]]
171173
==== Spring Tool Suite Visual Editor for Spring Integration

src/reference/asciidoc/changes-2.1-2.2.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Spring Integration now uses Spring 3.1.
5050
The ability to add an `<advice-chain/>` to a poller has been available for some time.
5151
However, the behavior added by this affects the entire integration flow.
5252
It did not address the ability to add (for example) retry to an individual endpoint.
53-
The 2.2. release introduced the `<request-handler-advice-chain/>` to many endpoints.
53+
The 2.2 release introduced the `<request-handler-advice-chain/>` to many endpoints.
5454

5555
In addition, we added three standard advice classes for this purpose:
5656

src/reference/asciidoc/changes-4.1-4.2.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,8 @@ See <<jms-outbound-gateway>> for more information.
213213

214214
===== Conversion Errors in Message-Driven Endpoints
215215

216-
The `error-channel` is now used for the conversion errors. In previous versions, they caused transaction rollback and message redelivery.
216+
The `error-channel` is now used for the conversion errors.
217+
In previous versions, they caused transaction rollback and message redelivery.
217218

218219
See <<jms-message-driven-channel-adapter>> and <<jms-inbound-gateway>> for more information.
219220

src/reference/asciidoc/channel-adapter.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,8 @@ If you want the script to be checked on each poll, you would need to coordinate
147147
====
148148

149149
See also the `cacheSeconds` property on the `ReloadableResourceBundleExpressionSource` when using the `<expression/>` sub-element.
150-
For more information regarding expressions, see <<spel>>. For scripts, see <<groovy>> and <<scripting>>.
150+
For more information regarding expressions, see <<spel>>.
151+
For scripts, see <<groovy>> and <<scripting>>.
151152

152153
IMPORTANT: The `<int:inbound-channel-adapter/>` is endpoint starts a message flow by periodically triggering to poll some underlying `MessageSource`.
153154
Since, at the time of polling, there is no message object, expressions and scripts do not have access to a root `Message`, so there are no payload or headers properties that are available in most other messaging SpEL expressions.

src/reference/asciidoc/channel.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -857,7 +857,8 @@ Instead, Spring Integration focuses on a single unified approach to configuring
857857
What makes certain parts of the message flow synchronous or asynchronous is the type of Message Channel that has been configured within that flow.
858858
That is one of the primary benefits of the message channel abstraction.
859859
From the inception of the framework, we have always emphasized the need and the value of the message channel as a first-class citizen of the framework.
860-
It is not just an internal, implicit realization of the EIP pattern. It is fully exposed as a configurable component to the end user.
860+
It is not just an internal, implicit realization of the EIP pattern.
861+
It is fully exposed as a configurable component to the end user.
861862
So, the wire tap component is only responsible for performing the following tasks:
862863

863864
* Intercept a message flow by tapping into a channel (for example, `channelA`)

src/reference/asciidoc/codec.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,8 @@ The second and third are used with the `MessageCodec`, which is initialized with
5454

5555
By default, Kryo delegates unknown Java types to its `FieldSerializer`.
5656
Kryo also registers default serializers for each primitive type, along with `String`, `Collection`, and `Map`.
57-
`FieldSerializer` uses reflection to navigate the object graph. A more efficient approach is to implement a custom
58-
serializer that is aware of the object's structure and can directly serialize selected primitive fields.
57+
`FieldSerializer` uses reflection to navigate the object graph.
58+
A more efficient approach is to implement a custom serializer that is aware of the object's structure and can directly serialize selected primitive fields.
5959
The following example shows such a serializer:
6060

6161
====

src/reference/asciidoc/dsl.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,7 @@ public IntegrationFlow clientTcpFlow() {
301301
}
302302
----
303303

304-
i.e. they are not merged, only the `testAdvice()` bean is used in this case.
304+
That is they are not merged, only the `testAdvice()` bean is used in this case.
305305

306306
[[java-dsl-transformers]]
307307
=== Transformers

src/reference/asciidoc/endpoint.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,8 @@ The `receiveTimeout` property specifies the amount of time the poller should wai
149149
For example, consider two options that seem similar on the surface but are actually quite different: The first has an interval trigger of 5 seconds and a receive timeout of 50 milliseconds, while the second has an interval trigger of 50 milliseconds and a receive timeout of 5 seconds.
150150
The first one may receive a message up to 4950 milliseconds later than it arrived on the channel (if that message arrived immediately after one of its poll calls returned).
151151
On the other hand, the second configuration never misses a message by more than 50 milliseconds.
152-
The difference is that the second option requires a thread to wait. However, as a result, it can respond much more quickly to arriving messages.
152+
The difference is that the second option requires a thread to wait.
153+
However, as a result, it can respond much more quickly to arriving messages.
153154
This technique, known as "`long polling`", can be used to emulate event-driven behavior on a polled source.
154155

155156
A polling consumer can also delegate to a Spring `TaskExecutor`, as the following example shows:
@@ -770,7 +771,8 @@ public Map<String, Boolean> getEndpointsRunningStatus(String role) <4>
770771

771772
<3> Returns `true` if none of the endpoints in the role are running.
772773

773-
<4> Returns a map of `component name : running status`. The component name is usually the bean name.
774+
<4> Returns a map of `component name : running status`.
775+
The component name is usually the bean name.
774776

775777
[[leadership-event-handling]]
776778
=== Leadership Event Handling

0 commit comments

Comments
 (0)