polishing

docs/src/reference/docbook/resource.xml

@@ -6,7 +6,7 @@
   <section id="resource-intro">
     <title>Introduction</title>
     <para>
-      <emphasis>Resource Inbound Channel Adapter</emphasis> builds upon Spring's <classname>Resource</classname> abstraction to 
+      The <emphasis>Resource Inbound Channel Adapter</emphasis> builds upon Spring's <classname>Resource</classname> abstraction to 
       support greater flexibility across a variety of actual types of underlying resources, such as a file, a URL, 
       or a class path resource. Therefore, it's similar to but more generic than the 
       <emphasis>File Inbound Channel Adapter</emphasis>.
@@ -16,72 +16,79 @@
   <section id="resource-inbound-channel-adapter">
     <title>Resource Inbound Channel Adapter</title>
     <para>
-    <emphasis>Resource Inbound Channel Adapter</emphasis> is a polling adapter that creates a <classname>Message</classname> 
-    with collection of <classname>Resource</classname> objects as payload
+    The <emphasis>Resource Inbound Channel Adapter</emphasis> is a polling adapter that creates a <classname>Message</classname> 
+    whose payload is a collection of <classname>Resource</classname> objects.
     </para>
     <para>
-    <classname>Resource</classname> objects are resolved based on the pattern specified using <code>pattern</code> attribute. 
-    The collection of the resolved <classname>Resource</classname> objects is than sent as a payload with an 
-    outgoing <classname>Message</classname>. That is one major difference that <emphasis>Resource Inbound Channel Adapter</emphasis> 
-    has with <emphasis>File Inbound Channel Adapter</emphasis> which buffers File objects and sends a single <classname>File</classname> object per 
+    <classname>Resource</classname> objects are resolved based on the pattern specified using the <code>pattern</code> attribute. 
+    The collection of resolved <classname>Resource</classname> objects is then sent as a payload within a
+    <classname>Message</classname> to the adapter's channel. That is one major difference between <emphasis>Resource Inbound Channel Adapter</emphasis> 
+    and <emphasis>File Inbound Channel Adapter</emphasis>; the latter buffers File objects and sends a single <classname>File</classname> object per 
     <classname>Message</classname>.
     </para>
     <para>
-    Below is an example of very simple configuration which will find all files with 'property' 
+    Below is an example of a very simple configuration which will find all files ending with the 'properties' 
     extension in the <code>foo.bar</code> package available on the classpath and will send them as 
-    payload of a Message to <code>resultChannel</code>:
+    the payload of a Message to the channel named '<code>resultChannel</code>':
     
-      <programlisting language="xml"><![CDATA[<int:resource-inbound-channel-adapter id="resourceAdapterDefault" channel="resultChannel" 
-               pattern="classpath:foo/bar/*.property">
-	<int:poller fixed-rate="1000"/>
+      <programlisting language="xml"><![CDATA[<int:resource-inbound-channel-adapter id="resourceAdapter"
+               channel="resultChannel" 
+               pattern="classpath:foo/bar/*.properties">
+    <int:poller fixed-rate="1000"/>
 </int:resource-inbound-channel-adapter>]]></programlisting>
     </para>
     <para>
-      <emphasis>Resource Inbound Channel Adapter</emphasis> relies on 
-      <classname>org.springframework.core.io.support.ResourcePatternResolver</classname> to resolve provided pattern. 
-      It defaults to an instance of the current <classname>ApplicationContext</classname>. However you may provide your own 
-      instance of the <classname>ResourcePatternResolver</classname> using <code>pattern-resolver</code> attribute:
-      <programlisting language="xml"><![CDATA[<int:resource-inbound-channel-adapter id="resourceAdapter" channel="resultChannel" 
-               pattern="classpath:foo/bar/*.property" pattern-resolver="myPatternResolver">
-	<int:poller fixed-rate="1000"/>
+      The <emphasis>Resource Inbound Channel Adapter</emphasis> relies on the 
+      <classname>org.springframework.core.io.support.ResourcePatternResolver</classname> strategy interface to resolve the provided pattern. 
+      It defaults to an instance of the current <classname>ApplicationContext</classname>. However you may provide a reference to an instance
+      of your own implementation of <classname>ResourcePatternResolver</classname> using the <code>pattern-resolver</code> attribute:
+      <programlisting language="xml"><![CDATA[<int:resource-inbound-channel-adapter id="resourceAdapter"
+               channel="resultChannel" 
+               pattern="classpath:foo/bar/*.properties"
+               pattern-resolver="myPatternResolver">
+    <int:poller fixed-rate="1000"/>
 </int:resource-inbound-channel-adapter>
 
-<bean id="myPatternResolver" class="org.bar.MyPatternResolver"/>]]></programlisting>
+<bean id="myPatternResolver" class="org.example.MyPatternResolver"/>]]></programlisting>
     </para>
     <para>
-      There may be a use case where you might want to filter resources in addition to what was already 
+      You may have a use case where you need to further filter the collection of resources 
       resolved by the <classname>ResourcePatternResolver</classname>. For example, you may want to prevent resources 
-      that were resolved once to never appear in the collection of resolved resources ever again. On the other hand 
-      your resources might be updated rather often and you DO want them to be picked up again. In other words 
-      there is a valid use case for defining an additional filter as well as use no additional filtering at all. 
-      You can accomplish this by providing your own implementation of <classname>org.springframework.integration.util.CollectionFilter</classname> 
-      strategy:
+      that were resolved already from appearing in a collection of resolved resources ever again. On the other hand 
+      your resources might be updated rather often and you <emphasis>do</emphasis> want them to be picked up again.
+      In other words there is a valid use case for defining an additional filter as well as disabling filtering altogether. 
+      You can provide your own implementation of the <classname>org.springframework.integration.util.CollectionFilter</classname> 
+      strategy interface:
       <programlisting language="java"><![CDATA[public interface CollectionFilter<T> {
 
-	Collection<T> filter(Collection<T> unfilteredElements);
+    Collection<T> filter(Collection<T> unfilteredElements);
 
 }]]></programlisting>
 		
-		As you can see the <classname>CollectionFilter</classname> receives a collection of un-filtered <classname>Resource</classname>
-		 objects and returns a collection of filtered <classname>Resource</classname> objects.
+		As you can see the <classname>CollectionFilter</classname> receives a collection of un-filtered elements
+		(which would be <classname>Resource</classname> objects in this case), and it returns a collection of
+		filtered elements of that same type.
 
     </para>
     <para>
-    The default implementation of <classname>CollectionFilter</classname> used by the <emphasis>Resource Inbound Channel Adapter</emphasis> 
-    is <classname>org.springframework.integration.util.AcceptOnceCollectionFilter</classname> which remembers the 
-    elements passed in the previous invocation in order to avoid returning those elements more than once.
+    If you are defining the adapter via XML but you do not specify a filter reference, a default implementation of
+    <classname>CollectionFilter</classname> will be used by the <emphasis>Resource Inbound Channel Adapter</emphasis>.
+    The implementation class of that default filter is <classname>org.springframework.integration.util.AcceptOnceCollectionFilter</classname>.
+    It remembers the elements passed in the previous invocation in order to avoid returning those elements more than once.
     </para>
     <para>
-      To inject your own implementation of <classname>CollectionFilter</classname> use <code>filter</code> attribute.
-      <programlisting language="xml"><![CDATA[<int:resource-inbound-channel-adapter id="resourceAdapter" channel="resultChannel" 
-               pattern="classpath:foo/bar/*.property" filter="myFilter">
-	<int:poller fixed-rate="1000"/>
+      To inject your own implementation of <classname>CollectionFilter</classname> instead, use the <code>filter</code> attribute.
+      <programlisting language="xml"><![CDATA[<int:resource-inbound-channel-adapter id="resourceAdapter"
+               channel="resultChannel" 
+               pattern="classpath:foo/bar/*.properties"
+               filter="myFilter">
+    <int:poller fixed-rate="1000"/>
 </int:resource-inbound-channel-adapter>
 
-<bean id="myFilter" class="org.bar.MyFilter"/>]]></programlisting>
+<bean id="myFilter" class="org.example.MyFilter"/>]]></programlisting>
 
-    If you don't need any additional filtering and you want to disable default <classname>CollectionFilter</classname> strategy 
-    simply configure empty filter attribute (e.g., <code>filter=""</code>)
+    If you don't need any filtering and want to disable even the default <classname>CollectionFilter</classname> strategy,
+    simply provide an empty value for the filter attribute (e.g., <code>filter=""</code>)
     </para>
   </section>