Author: davsclaus
Date: Fri Dec  9 12:47:16 2011
New Revision: 1212380

URL: http://svn.apache.org/viewvc?rev=1212380&view=rev
Log:
CAMEL-4758: Polished javadoc. Thanks to Glen Mazza for the patch.

Modified:
    camel/trunk/camel-core/src/main/java/org/apache/camel/AsyncCallback.java
    camel/trunk/camel-core/src/main/java/org/apache/camel/BatchConsumer.java
    camel/trunk/camel-core/src/main/java/org/apache/camel/BinaryPredicate.java
    
camel/trunk/camel-core/src/main/java/org/apache/camel/CamelAuthorizationException.java
    camel/trunk/camel-core/src/main/java/org/apache/camel/CamelContext.java
    
camel/trunk/camel-core/src/main/java/org/apache/camel/FailedToCreateRouteException.java
    
camel/trunk/camel-core/src/main/java/org/apache/camel/InvalidPayloadException.java
    
camel/trunk/camel-core/src/main/java/org/apache/camel/MultipleConsumersSupport.java
    camel/trunk/camel-core/src/main/java/org/apache/camel/Ordered.java
    camel/trunk/camel-core/src/main/java/org/apache/camel/ProducerCallback.java
    
camel/trunk/camel-core/src/main/java/org/apache/camel/ProxyInstantiationException.java
    camel/trunk/camel-core/src/main/java/org/apache/camel/Route.java
    camel/trunk/camel-core/src/main/java/org/apache/camel/RouteNode.java
    camel/trunk/camel-core/src/main/java/org/apache/camel/RoutesBuilder.java
    
camel/trunk/camel-core/src/main/java/org/apache/camel/RuntimeConfiguration.java
    camel/trunk/camel-core/src/main/java/org/apache/camel/ShutdownRoute.java
    
camel/trunk/camel-core/src/main/java/org/apache/camel/ShutdownRunningTask.java
    
camel/trunk/camel-core/src/main/java/org/apache/camel/ShutdownableService.java
    camel/trunk/camel-core/src/main/java/org/apache/camel/StartupListener.java
    camel/trunk/camel-core/src/main/java/org/apache/camel/StatefulService.java
    camel/trunk/camel-core/src/main/java/org/apache/camel/StreamCache.java
    camel/trunk/camel-core/src/main/java/org/apache/camel/TimerListener.java
    camel/trunk/camel-core/src/main/java/org/apache/camel/Traceable.java

Modified: 
camel/trunk/camel-core/src/main/java/org/apache/camel/AsyncCallback.java
URL: 
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/AsyncCallback.java?rev=1212380&r1=1212379&r2=1212380&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/AsyncCallback.java 
(original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/AsyncCallback.java 
Fri Dec  9 12:47:16 2011
@@ -30,13 +30,13 @@ package org.apache.camel;
 public interface AsyncCallback {
 
     /**
-     * This method is invoked once the {@link Exchange is done}.
+     * This method is invoked once the {@link Exchange} is done.
      * <p/>
      * If an exception occurred while processing the exchange, the exception 
field of the
      * {@link Exchange} being processed will hold the caused exception.
      *
-     * @param doneSync is <tt>true</tt> if the processing of the {@link 
Exchange} was completed by the synchronously thread.
-     *                 Otherwise its <tt>false</tt> to indicate it was 
completed by the asynchronously thread.
+     * @param doneSync is <tt>true</tt> if the processing of the {@link 
Exchange} was completed by a synchronous thread.
+     *                 Otherwise its <tt>false</tt> to indicate it was 
completed by an asynchronous thread.
      */
     void done(boolean doneSync);
 

Modified: 
camel/trunk/camel-core/src/main/java/org/apache/camel/BatchConsumer.java
URL: 
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/BatchConsumer.java?rev=1212380&r1=1212379&r2=1212380&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/BatchConsumer.java 
(original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/BatchConsumer.java 
Fri Dec  9 12:47:16 2011
@@ -28,8 +28,8 @@ public interface BatchConsumer extends C
     /**
      * Sets a maximum number of messages as a limit to poll at each polling.
      * <p/>
-     * Can be used to limit eg to 100 to avoid when starting and there are 
millions
-     * of messages for you in the first poll.
+     * Can be used to limit e.g. to 100 to avoid reading thousands or more 
+     * messages within the first polling at startup.
      * <p/>
      * Is default unlimited, but use 0 or negative number to disable it as 
unlimited.
      *
@@ -38,7 +38,7 @@ public interface BatchConsumer extends C
     void setMaxMessagesPerPoll(int maxMessagesPerPoll);
 
     /**
-     * Processes the list of {@link org.apache.camel.Exchange} in a batch. 
+     * Processes the list of {@link org.apache.camel.Exchange} objects in a 
batch. 
      * <p/>
      * Each message exchange will be processed individually but the batch
      * consumer will add properties with the current index and total in the 
batch.
@@ -54,8 +54,8 @@ public interface BatchConsumer extends C
     /**
      * Whether processing the batch is still allowed.
      * <p/>
-     * This is used during shutdown to help indicate whether to complete the 
pending
-     * exchanges or stop after current exchange has been processed.
+     * This is used during shutdown to indicate whether to complete the pending
+     * exchanges or stop after the current exchange has been processed.
      *
      * @return <tt>true</tt> to continue processing from the batch, or 
<tt>false</tt> to stop.
      * @see org.apache.camel.ShutdownRunningTask

Modified: 
camel/trunk/camel-core/src/main/java/org/apache/camel/BinaryPredicate.java
URL: 
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/BinaryPredicate.java?rev=1212380&r1=1212379&r2=1212380&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/BinaryPredicate.java 
(original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/BinaryPredicate.java 
Fri Dec  9 12:47:16 2011
@@ -17,13 +17,13 @@
 package org.apache.camel;
 
 /**
- * A predicate which is evaluating a binary expression.
+ * A predicate which evaluates a binary expression.
  * <p/>
  * The predicate has a left and right hand side expressions which
  * is matched based on an operator.
  * <p/>
  * This predicate offers the {@link #matchesReturningFailureMessage} method
- * which evaluates and return a detailed failure message if the predicate did 
not match.
+ * which evaluates and returns a detailed failure message if the predicate did 
not match.
  *
  * @version 
  */
@@ -53,7 +53,7 @@ public interface BinaryPredicate extends
     /**
      * Evaluates the predicate on the message exchange and returns 
<tt>null</tt> if this
      * exchange matches the predicate. If it did <b>not</b> match, then a 
failure message
-     * is returned detailing why it did not fail, which can be used for end 
users to understand
+     * is returned detailing the reason, which can be used by end users to 
understand
      * the failure.
      *
      * @param exchange the message exchange

Modified: 
camel/trunk/camel-core/src/main/java/org/apache/camel/CamelAuthorizationException.java
URL: 
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/CamelAuthorizationException.java?rev=1212380&r1=1212379&r2=1212380&view=diff
==============================================================================
--- 
camel/trunk/camel-core/src/main/java/org/apache/camel/CamelAuthorizationException.java
 (original)
+++ 
camel/trunk/camel-core/src/main/java/org/apache/camel/CamelAuthorizationException.java
 Fri Dec  9 12:47:16 2011
@@ -17,6 +17,11 @@
 
 package org.apache.camel;
 
+/**
+ * An exception thrown for authorization errors occurring in a Camel exchange.
+ *
+ * @version 
+ */
 public class CamelAuthorizationException extends CamelExchangeException {
     private final String policyId;
     

Modified: 
camel/trunk/camel-core/src/main/java/org/apache/camel/CamelContext.java
URL: 
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/CamelContext.java?rev=1212380&r1=1212379&r2=1212380&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/CamelContext.java 
(original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/CamelContext.java Fri 
Dec  9 12:47:16 2011
@@ -63,15 +63,15 @@ import org.apache.camel.spi.UuidGenerato
  *   <li>{@link #resume()} - to resume after a suspend</li>
  * </ul>
  * <p/>
- * <b>Notice:</b> that {@link #stop()} and {@link #suspend()} will graceful 
stop/suspend routs ensuring any in progress
- * messages is given time to complete. See more details at {@link 
org.apache.camel.spi.ShutdownStrategy}.
+ * <b>Notice:</b> {@link #stop()} and {@link #suspend()} will gracefully 
stop/suspend routes ensuring any messages
+ * in progress will be given time to complete. See more details at {@link 
org.apache.camel.spi.ShutdownStrategy}.
  * <p/>
- * If you are doing a hot restart then its adviced to use the suspend/resume 
methods which ensures a faster
+ * If you are doing a hot restart then it's advised to use the suspend/resume 
methods which ensure a faster
  * restart but also allows any internal state to be kept as is.
  * The stop/start approach will do a <i>cold</i> restart of Camel, where all 
internal state is reset.
  * <p/>
- * End users is adviced to use suspend/resume. Using stop is for shutting down 
Camel and its not guaranteed that
- * when its being started again using the start method that everything works 
out of the box.
+ * End users are advised to use suspend/resume. Using stop is for shutting 
down Camel and it's not guaranteed that
+ * when it's being started again using the start method that Camel will 
operate consistently.
  *
  * @version 
  */

Modified: 
camel/trunk/camel-core/src/main/java/org/apache/camel/FailedToCreateRouteException.java
URL: 
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/FailedToCreateRouteException.java?rev=1212380&r1=1212379&r2=1212380&view=diff
==============================================================================
--- 
camel/trunk/camel-core/src/main/java/org/apache/camel/FailedToCreateRouteException.java
 (original)
+++ 
camel/trunk/camel-core/src/main/java/org/apache/camel/FailedToCreateRouteException.java
 Fri Dec  9 12:47:16 2011
@@ -40,7 +40,7 @@ public class FailedToCreateRouteExceptio
     }
 
     protected static String getRouteMessage(String route) {
-        // cut the route after 60 chars so it wont be too big in the message
+        // cut the route after 60 chars so it won't be too big in the message
         // users just need to be able to identify the route so they know where 
to look
         if (route.length() > 60) {
             return route.substring(0, 60) + "...";

Modified: 
camel/trunk/camel-core/src/main/java/org/apache/camel/InvalidPayloadException.java
URL: 
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/InvalidPayloadException.java?rev=1212380&r1=1212379&r2=1212380&view=diff
==============================================================================
--- 
camel/trunk/camel-core/src/main/java/org/apache/camel/InvalidPayloadException.java
 (original)
+++ 
camel/trunk/camel-core/src/main/java/org/apache/camel/InvalidPayloadException.java
 Fri Dec  9 12:47:16 2011
@@ -17,7 +17,7 @@
 package org.apache.camel;
 
 /**
- * Is thrown if the payload from the exchange could not be retrieve because of 
being null, wrong class type etc.
+ * Is thrown if the payload from the exchange could not be retrieved because 
of being null, wrong class type etc.
  *
  * @version 
  */

Modified: 
camel/trunk/camel-core/src/main/java/org/apache/camel/MultipleConsumersSupport.java
URL: 
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/MultipleConsumersSupport.java?rev=1212380&r1=1212379&r2=1212380&view=diff
==============================================================================
--- 
camel/trunk/camel-core/src/main/java/org/apache/camel/MultipleConsumersSupport.java
 (original)
+++ 
camel/trunk/camel-core/src/main/java/org/apache/camel/MultipleConsumersSupport.java
 Fri Dec  9 12:47:16 2011
@@ -18,15 +18,15 @@ package org.apache.camel;
 
 /**
  * {@link org.apache.camel.Endpoint} can optionally implement this interface to
- * indicate whether or not it supports multiple consumers or not.
+ * indicate whether or not it supports multiple consumers.
  * <p/>
- * By default endpoints is assumed <b>not</b> to support multiple consumers.
+ * By default endpoints are assumed <b>not</b> to support multiple consumers.
  * <p/>
- * A rare few endpoint does in fact support multiple consumers and thus the 
purpose of this interface.
- * For example JMS endpoints which has topics that can be consumed by multiple 
consumers.
+ * A rare few endpoints do in fact support multiple consumers and thus the 
purpose of this interface.
+ * For example JMS endpoints which have topics that can be consumed by 
multiple consumers.
  * <p/>
  * The purpose of this is to check on startup that we do not have multiple 
consumers
- * for the <b>same</b> endpoints. This prevent starting up when there was a 
copy/paste mistakes in the Camel routes.
+ * for the <b>same</b> endpoints. This prevents starting up with copy/paste 
mistakes in the Camel routes.
  *
  * @version 
  */

Modified: camel/trunk/camel-core/src/main/java/org/apache/camel/Ordered.java
URL: 
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/Ordered.java?rev=1212380&r1=1212379&r2=1212380&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/Ordered.java 
(original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/Ordered.java Fri Dec  
9 12:47:16 2011
@@ -17,7 +17,7 @@
 package org.apache.camel;
 
 /**
- * Interface to be implement by objects that should be orderable, such as in a 
{@link java.util.Collection}.
+ * Interface to be implemented by objects that should be orderable, such as 
with a {@link java.util.Collection}.
  *
  * @version 
  */

Modified: 
camel/trunk/camel-core/src/main/java/org/apache/camel/ProducerCallback.java
URL: 
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/ProducerCallback.java?rev=1212380&r1=1212379&r2=1212380&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/ProducerCallback.java 
(original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/ProducerCallback.java 
Fri Dec  9 12:47:16 2011
@@ -29,7 +29,7 @@ public interface ProducerCallback<T> {
     /**
      * Performs operation on the given producer to send the given exchange.
      *
-     * @param producer        the producer, is newer <tt>null</tt>
+     * @param producer        the producer, is never <tt>null</tt>
      * @param exchange        the exchange, can be <tt>null</tt> if so then 
create a new exchange from the producer
      * @param exchangePattern the exchange pattern, can be <tt>null</tt>
      * @return the response

Modified: 
camel/trunk/camel-core/src/main/java/org/apache/camel/ProxyInstantiationException.java
URL: 
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/ProxyInstantiationException.java?rev=1212380&r1=1212379&r2=1212380&view=diff
==============================================================================
--- 
camel/trunk/camel-core/src/main/java/org/apache/camel/ProxyInstantiationException.java
 (original)
+++ 
camel/trunk/camel-core/src/main/java/org/apache/camel/ProxyInstantiationException.java
 Fri Dec  9 12:47:16 2011
@@ -17,7 +17,7 @@
 package org.apache.camel;
 
 /**
- * A proxy creation failed trying to create a proxy of a given type and on an 
given endpoint
+ * Exception indicating a failure while trying to create a proxy of a given 
type and on a given endpoint
  *
  * @version 
  */

Modified: camel/trunk/camel-core/src/main/java/org/apache/camel/Route.java
URL: 
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/Route.java?rev=1212380&r1=1212379&r2=1212380&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/Route.java (original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/Route.java Fri Dec  9 
12:47:16 2011
@@ -69,7 +69,7 @@ public interface Route {
     RouteContext getRouteContext();
 
     /**
-     * A strategy callback allowing special initialization when services is 
starting.
+     * A strategy callback allowing special initialization when services are 
starting.
      *
      * @param services the service
      * @throws Exception is thrown in case of error

Modified: camel/trunk/camel-core/src/main/java/org/apache/camel/RouteNode.java
URL: 
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/RouteNode.java?rev=1212380&r1=1212379&r2=1212380&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/RouteNode.java 
(original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/RouteNode.java Fri 
Dec  9 12:47:16 2011
@@ -35,7 +35,7 @@ public interface RouteNode {
     /**
      * Gets the model definition that represents this node
      *
-     * @return the definition, is newer <tt>null</tt>
+     * @return the definition, is never <tt>null</tt>
      */
     ProcessorDefinition<?> getProcessorDefinition();
 
@@ -50,7 +50,7 @@ public interface RouteNode {
     /**
      * Whether this node is abstract (no real processor under the cover).
      * <p/>
-     * Some nodes is abstract that represents intermediate steps for instance 
with
+     * Some nodes that represent intermediate steps are abstract, for instance 
with
      * onException, onCompletion or intercept
      *
      * @return whether this node is abstract or not

Modified: 
camel/trunk/camel-core/src/main/java/org/apache/camel/RoutesBuilder.java
URL: 
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/RoutesBuilder.java?rev=1212380&r1=1212379&r2=1212380&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/RoutesBuilder.java 
(original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/RoutesBuilder.java 
Fri Dec  9 12:47:16 2011
@@ -19,7 +19,7 @@ package org.apache.camel;
 /**
  * A routes builder is capable of building routes using the builder and model 
classes.
  * <p/>
- * Eventually the routes is added to a {@link org.apache.camel.CamelContext} 
where they
+ * Eventually the routes are added to a {@link org.apache.camel.CamelContext} 
where they
  * run inside.
  */
 public interface RoutesBuilder {

Modified: 
camel/trunk/camel-core/src/main/java/org/apache/camel/RuntimeConfiguration.java
URL: 
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/RuntimeConfiguration.java?rev=1212380&r1=1212379&r2=1212380&view=diff
==============================================================================
--- 
camel/trunk/camel-core/src/main/java/org/apache/camel/RuntimeConfiguration.java 
(original)
+++ 
camel/trunk/camel-core/src/main/java/org/apache/camel/RuntimeConfiguration.java 
Fri Dec  9 12:47:16 2011
@@ -17,8 +17,8 @@
 package org.apache.camel;
 
 /**
- * Various runtime configuration used by {@link org.apache.camel.CamelContext} 
and {@link org.apache.camel.spi.RouteContext}
- * for cross cutting functions such as tracing, delayer, stream cache and the 
likes.
+ * Various runtime configuration options used by {@link 
org.apache.camel.CamelContext} and {@link org.apache.camel.spi.RouteContext}
+ * for cross cutting functions such as tracing, delayer, stream cache and the 
like.
  *
  * @version 
  */
@@ -27,7 +27,6 @@ public interface RuntimeConfiguration {
     /**
      * Sets whether stream caching is enabled or not (default is disabled).
      * <p/>
-     * Is disabled by default
      *
      * @param cache whether stream caching is enabled or not
      */
@@ -43,9 +42,8 @@ public interface RuntimeConfiguration {
     /**
      * Sets whether tracing is enabled or not (default is disabled).
      * <p/>
-     * Is disabled by default
      *
-     * @param tracing whether tracing is enabled or not.
+     * @param tracing whether to enable tracing.
      */
     void setTracing(Boolean tracing);
 
@@ -57,24 +55,23 @@ public interface RuntimeConfiguration {
     Boolean isTracing();
 
     /**
-     * Sets whether handle fault is enabled or not (default is disabled).
+     * Sets whether fault handling is enabled or not (default is disabled).
      * <p/>
-     * Is disabled by default
      *
-     * @param handleFault whether handle fault is enabled or not.
+     * @param handleFault whether to enable fault handling.
      */
     void setHandleFault(Boolean handleFault);
 
     /**
-     * Returns whether tracing enabled
+     * Returns whether fault handling enabled
      *
-     * @return true if tracing is enabled
+     * @return true if fault handling is enabled
      */
     Boolean isHandleFault();
 
     /**
      * Sets a delay value in millis that a message is delayed at every step it 
takes in the route path,
-     * to slow things down to better helps you to see what goes
+     * slowing the process down to better observe what is occurring
      * <p/>
      * Is disabled by default
      *
@@ -90,50 +87,47 @@ public interface RuntimeConfiguration {
     Long getDelayer();
 
     /**
-     * Sets whether it should automatic start when Camel starts.
+     * Sets whether the object should automatically start when Camel starts.
      * <p/>
-     * Currently only routes can be disabled, as {@link CamelContext} itself 
are always started}
+     * Currently only routes can be disabled, as {@link CamelContext}s are 
always started.
      * <br/>
-     * Default is true to always startup.
+     * Default is true to always start up.
      *
-     * @param autoStartup  whether to auto startup.
+     * @param autoStartup whether to start up automatically.
      */
     void setAutoStartup(Boolean autoStartup);
 
     /**
-     * Gets whether it should automatic start when Camel starts.
+     * Gets whether the object should automatically start when Camel starts.
      *
-     * @return true if should auto start
+     * @return true if object should automatically start
      */
     Boolean isAutoStartup();
 
     /**
-     * Sets the option to use when shutting down routes.
+     * Sets the ShutdownRoute option for routes.
      *
      * @param shutdownRoute the option to use.
      */
     void setShutdownRoute(ShutdownRoute shutdownRoute);
 
     /**
-     * Gets the option to use when shutting down route.
+     * Gets the option to use when shutting down the route.
      *
      * @return the option
      */
     ShutdownRoute getShutdownRoute();
 
     /**
-     * Sets the option to use when shutting down a route and how to act when 
it has running tasks.
+     * Sets the ShutdownRunningTask option to use when shutting down a route.
      * <p/>
-     * A running task is for example a {@link org.apache.camel.BatchConsumer} 
which has a group
-     * of messages to process. With this option you can control whether it 
should complete the entire
-     * group or stop after the current message has been processed.
      *
      * @param shutdownRunningTask the option to use.
      */
     void setShutdownRunningTask(ShutdownRunningTask shutdownRunningTask);
 
     /**
-     * Gets the option to use when shutting down a route and how to act when 
it has running tasks.
+     * Gets the ShutdownRunningTask option in use when shutting down a route.
      *
      * @return the option
      */

Modified: 
camel/trunk/camel-core/src/main/java/org/apache/camel/ShutdownRoute.java
URL: 
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/ShutdownRoute.java?rev=1212380&r1=1212379&r2=1212380&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/ShutdownRoute.java 
(original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/ShutdownRoute.java 
Fri Dec  9 12:47:16 2011
@@ -20,17 +20,17 @@ import javax.xml.bind.annotation.XmlEnum
 import javax.xml.bind.annotation.XmlType;
 
 /**
- * Represent the kinds of options for shutting down.
+ * Represents the options available when shutting down routes.
  * <p/>
- * Is used for example to defer shutting down a route until all inflight 
exchanges has
- * been completed, by which the route safely can be shutdown.
+ * Is used for example to defer shutting down a route until all inflight 
exchanges have
+ * been completed, after which the route can be shutdown safely.
  * <p/>
- * This allows fine grained configuration to accomplish graceful shutdown and 
you
- * for example have some internal route which other routes is dependent upon.
+ * This allows fine grained configuration in accomplishing graceful shutdown 
where you
+ * have for example some internal route which other routes are dependent upon.
  * <ul>
- *   <li>Default - The <b>default</b> behavior where a route will either be 
attempted to shutdown now</li>
+ *   <li>Default - The <b>default</b> behavior where a route will attempt to 
shutdown now</li>
  *   <li>Defer - Will defer shutting down the route and let it be active 
during graceful shutdown.
- *               The route will at a later stage be shutdown during the 
graceful shutdown process.</li>
+ *               The route will be shutdown at a later stage during the 
graceful shutdown process.</li>
  * </ul>
  */
 @XmlType

Modified: 
camel/trunk/camel-core/src/main/java/org/apache/camel/ShutdownRunningTask.java
URL: 
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/ShutdownRunningTask.java?rev=1212380&r1=1212379&r2=1212380&view=diff
==============================================================================
--- 
camel/trunk/camel-core/src/main/java/org/apache/camel/ShutdownRunningTask.java 
(original)
+++ 
camel/trunk/camel-core/src/main/java/org/apache/camel/ShutdownRunningTask.java 
Fri Dec  9 12:47:16 2011
@@ -23,17 +23,17 @@ import javax.xml.bind.annotation.XmlType
  * Represents the kind of options for what to do with the current task when 
shutting down.
  * <p/>
  * By default the current task is allowed to complete. However some consumers 
such as
- * {@link BatchConsumer} has pending tasks which you can configure to
- * let it complete all those tasks as well.
+ * {@link BatchConsumer} have pending tasks which you can configure the 
consumer 
+ * to complete as well.
  * <ul>
  *   <li>CompleteCurrentTaskOnly - Is the <b>default</b> behavior where a 
route consumer will be shutdown as fast as
  *                                 possible. Allowing it to complete its 
current task, but not to pickup pending
  *                                 tasks (if any).</li>
- *   <li>CompleteAllTasks - Allows a route consumer to do <i>do its 
business</i> which means that it will continue
- *                          to complete any pending tasks (if any).</li>
+ *   <li>CompleteAllTasks - Allows a route consumer to continue to complete 
all pending tasks (if any).</li> 
+ *                          
  * </ul>
- * <b>Notice:</b> Most consumers only have a single tasks, but {@link 
org.apache.camel.BatchConsumer} can have
- * many tasks and thus this option mostly apply to these kind of consumers.
+ * <b>Notice:</b> Most consumers only have a single task, but {@link 
org.apache.camel.BatchConsumer} can have
+ * many tasks and thus this option mostly applies to this kind of consumer.
  */
 @XmlType
 @XmlEnum(String.class)

Modified: 
camel/trunk/camel-core/src/main/java/org/apache/camel/ShutdownableService.java
URL: 
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/ShutdownableService.java?rev=1212380&r1=1212379&r2=1212380&view=diff
==============================================================================
--- 
camel/trunk/camel-core/src/main/java/org/apache/camel/ShutdownableService.java 
(original)
+++ 
camel/trunk/camel-core/src/main/java/org/apache/camel/ShutdownableService.java 
Fri Dec  9 12:47:16 2011
@@ -17,12 +17,12 @@
 package org.apache.camel;
 
 /**
- * A {@link org.apache.camel.Service} which is also capable of shutting down.
+ * A {@link org.apache.camel.Service} which is capable of being shut down.
  * <p/>
- * This is useable for services which needs more fine grained control when 
{@link CamelContext} is shutting down.
- * Then its possible to have different behavior when stopping or shutting down.
+ * This is useful for services which need more fine grained control when the 
{@link CamelContext} is shutting down.
+ * This allows customization of behavior when stopping or shutting down.
  * <p/>
- * For example to shutdown thread pools on shutdown and <b>not</b> on stop.
+ * For example to shutdown thread pools during shutdown and <b>not</b> at 
CamelContext termination.
  *
  * @version 
  */
@@ -31,7 +31,7 @@ public interface ShutdownableService ext
     /**
      * Shutdown the service, which means it cannot be started again.
      *
-     * @throws Exception is thrown if shutting down failed
+     * @throws Exception thrown if shutting down failed
      */
     void shutdown() throws Exception;
 

Modified: 
camel/trunk/camel-core/src/main/java/org/apache/camel/StartupListener.java
URL: 
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/StartupListener.java?rev=1212380&r1=1212379&r2=1212380&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/StartupListener.java 
(original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/StartupListener.java 
Fri Dec  9 12:47:16 2011
@@ -17,14 +17,14 @@
 package org.apache.camel;
 
 /**
- * Allows objects to be notified when {@link CamelContext} have just been 
started.
+ * Allows objects to be notified when {@link CamelContext} has just been 
started.
  * <p/>
  * This can be used to perform any custom work when the entire {@link 
CamelContext} has been initialized and started.
- * For example this ensures that all the Camel routes has been started and are 
up and running, before this callback
- * is being invoked.
+ * For example this ensures that all Camel routes have been started and are up 
and running, before this callback
+ * is invoked.
  * <p/>
- * For example the QuartzComponent leverages this to ensure the Quartz 
scheduler is started late, when all the
- * Camel routes and services already have been started.
+ * For example the QuartzComponent leverages this to ensure the Quartz 
scheduler does not start until after all the
+ * Camel routes and services have already been started.
  *
  * @version 
  */

Modified: 
camel/trunk/camel-core/src/main/java/org/apache/camel/StatefulService.java
URL: 
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/StatefulService.java?rev=1212380&r1=1212379&r2=1212380&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/StatefulService.java 
(original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/StatefulService.java 
Fri Dec  9 12:47:16 2011
@@ -17,7 +17,7 @@
 package org.apache.camel;
 
 /**
- * A {@link Service} which has all the lifecycles events and offers details 
about its current state.
+ * A {@link Service} which has all the lifecycle events and offers details 
about its current state.
  */
 public interface StatefulService extends SuspendableService, 
ShutdownableService {
 

Modified: camel/trunk/camel-core/src/main/java/org/apache/camel/StreamCache.java
URL: 
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/StreamCache.java?rev=1212380&r1=1212379&r2=1212380&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/StreamCache.java 
(original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/StreamCache.java Fri 
Dec  9 12:47:16 2011
@@ -22,7 +22,7 @@ import java.io.OutputStream;
 /**
  * Tagging interface to indicate that a type is capable of caching the 
underlying data stream.
  * <p/>
- * This is a useful feature for avoid message re-readability issues.
+ * This is a useful feature for avoiding message re-readability issues.
  * This interface is mainly used by the {@link 
org.apache.camel.processor.interceptor.StreamCachingInterceptor}
  * for determining if/how to wrap a stream-based message.
  *

Modified: 
camel/trunk/camel-core/src/main/java/org/apache/camel/TimerListener.java
URL: 
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/TimerListener.java?rev=1212380&r1=1212379&r2=1212380&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/TimerListener.java 
(original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/TimerListener.java 
Fri Dec  9 12:47:16 2011
@@ -19,7 +19,7 @@ package org.apache.camel;
 /**
  * Listener for receiving timer events.
  * <p/>
- * For example to periodically to update internal state.
+ * For example to periodically update internal state.
  *
  * @see org.apache.camel.support.TimerListenerManager
  */

Modified: camel/trunk/camel-core/src/main/java/org/apache/camel/Traceable.java
URL: 
http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/Traceable.java?rev=1212380&r1=1212379&r2=1212380&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/Traceable.java 
(original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/Traceable.java Fri 
Dec  9 12:47:16 2011
@@ -18,7 +18,7 @@ package org.apache.camel;
 
 /**
  * Traceable processors allowing easier tracing using constructed labels to 
help identify the processor
- * and where its defined in the route model.
+ * and where it's defined in the route model.
  *
  * @version 
  */


Reply via email to