svn commit: r1342214 - in /camel/trunk/camel-core/src/main/java/org/apache/camel: CamelContext.java model/ModelCamelContext.java model/ProcessorDefinition.java

[da...@apache.org]

Author: davsclaus
Date: Thu May 24 12:03:58 2012
New Revision: 1342214

URL: http://svn.apache.org/viewvc?rev=1342214&view=rev
Log:
Added javadoc about route id should be unique

Modified:
    camel/trunk/camel-core/src/main/java/org/apache/camel/CamelContext.java
    camel/trunk/camel-core/src/main/java/org/apache/camel/model/ModelCamelContext.java
    camel/trunk/camel-core/src/main/java/org/apache/camel/model/ProcessorDefinition.java

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=1342214&r1=1342213&r2=1342214&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 Thu May 24 12:03:58 2012
@@ -366,6 +366,10 @@ public interface CamelContext extends Su
      * <b>Important:</b> The added routes will <b>only</b> be started, if {@link CamelContext}
      * is already started. You may want to check the state of {@link CamelContext} before
      * adding the routes, using the {@link org.apache.camel.CamelContext#getStatus()} method.
+     * <p/>
+     * <b>Important: </b> Each route in the same {@link org.apache.camel.CamelContext} must have an <b>unique</b> route id.
+     * If you use the API from {@link org.apache.camel.CamelContext} or {@link org.apache.camel.model.ModelCamelContext} to add routes, then any
+     * new routes which has a route id that matches an old route, then the old route is replaced by the new route.
      *
      * @param builder the builder which will create the routes and add them to this context
      * @throws Exception if the routes could not be created for whatever reason

Modified: camel/trunk/camel-core/src/main/java/org/apache/camel/model/ModelCamelContext.java
URL: http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/model/ModelCamelContext.java?rev=1342214&r1=1342213&r2=1342214&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/model/ModelCamelContext.java (original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/model/ModelCamelContext.java Thu May 24 12:03:58 2012
@@ -54,6 +54,10 @@ public interface ModelCamelContext exten
 
     /**
      * Adds a collection of route definitions to the context
+     * <p/>
+     * <b>Important: </b> Each route in the same {@link org.apache.camel.CamelContext} must have an <b>unique</b> route id.
+     * If you use the API from {@link org.apache.camel.CamelContext} or {@link org.apache.camel.model.ModelCamelContext} to add routes, then any
+     * new routes which has a route id that matches an old route, then the old route is replaced by the new route.
      *
      * @param routeDefinitions the route(s) definition to add
      * @throws Exception if the route definitions could not be created for whatever reason
@@ -62,6 +66,10 @@ public interface ModelCamelContext exten
 
     /**
      * Add a route definition to the context
+     * <p/>
+     * <b>Important: </b> Each route in the same {@link org.apache.camel.CamelContext} must have an <b>unique</b> route id.
+     * If you use the API from {@link org.apache.camel.CamelContext} or {@link org.apache.camel.model.ModelCamelContext} to add routes, then any
+     * new routes which has a route id that matches an old route, then the old route is replaced by the new route.
      *
      * @param routeDefinition the route definition to add
      * @throws Exception if the route definition could not be created for whatever reason

Modified: camel/trunk/camel-core/src/main/java/org/apache/camel/model/ProcessorDefinition.java
URL: http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/model/ProcessorDefinition.java?rev=1342214&r1=1342213&r2=1342214&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/model/ProcessorDefinition.java (original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/model/ProcessorDefinition.java Thu May 24 12:03:58 2012
@@ -989,9 +989,13 @@ public abstract class ProcessorDefinitio
     }
 
     /**
-     * Set the route id for this route
+     * Set the route id for this route.
+     * <p/>
+     * <b>Important: </b> Each route in the same {@link org.apache.camel.CamelContext} must have an <b>unique</b> route id.
+     * If you use the API from {@link org.apache.camel.CamelContext} or {@link ModelCamelContext} to add routes, then any
+     * new routes which has a route id that matches an old route, then the old route is replaced by the new route.
      *
-     * @param id  the route id
+     * @param id  the route id, should be unique
      * @return the builder
      */
     @SuppressWarnings("unchecked")