svn commit: r533681 - /activemq/camel/trunk/camel-spring/src/main/java/org/apache/camel/spring/CamelContextFactoryBean.java

[jstrachan]

Author: jstrachan
Date: Mon Apr 30 03:31:30 2007
New Revision: 533681

URL: http://svn.apache.org/viewvc?view=rev&rev=533681
Log:
updated the javadoc

Modified:
    
activemq/camel/trunk/camel-spring/src/main/java/org/apache/camel/spring/CamelContextFactoryBean.java

Modified: 
activemq/camel/trunk/camel-spring/src/main/java/org/apache/camel/spring/CamelContextFactoryBean.java
URL: 
http://svn.apache.org/viewvc/activemq/camel/trunk/camel-spring/src/main/java/org/apache/camel/spring/CamelContextFactoryBean.java?view=diff&rev=533681&r1=533680&r2=533681
==============================================================================
--- 
activemq/camel/trunk/camel-spring/src/main/java/org/apache/camel/spring/CamelContextFactoryBean.java
 (original)
+++ 
activemq/camel/trunk/camel-spring/src/main/java/org/apache/camel/spring/CamelContextFactoryBean.java
 Mon Apr 30 03:31:30 2007
@@ -29,8 +29,9 @@
 import java.util.List;
 
 /**
- * A Spring [EMAIL PROTECTED] FactoryBean} to create and initialize a Camel 
[EMAIL PROTECTED]
- * and install routes either explicitly configured in Spring or found by 
searching the classpath.
+ * A Spring [EMAIL PROTECTED] FactoryBean} to create and initialize a [EMAIL 
PROTECTED] SpringCamelContext}
+ * and install routes either explicitly configured in Spring XML or found by 
searching the classpath for Java classes
+ * which extend [EMAIL PROTECTED] RouteBuilder} using the nested [EMAIL 
PROTECTED] #setPackages(String[])}.
  *
  * @version $Revision$
  */
@@ -87,10 +88,16 @@
         return routeBuilder;
     }
 
+    /**
+     * Set a single [EMAIL PROTECTED] RouteBuilder} to be used to create the 
default routes on startup
+     */
     public void setRouteBuilder(RouteBuilder routeBuilder) {
         this.routeBuilder = routeBuilder;
     }
 
+    /**
+     * Set a collection of [EMAIL PROTECTED] RouteBuilder} instances to be 
used to create the default routes on startup
+     */
     public void setRouteBuilders(RouteBuilder[] builders) {
         for (RouteBuilder builder : builders) {
             additionalBuilders.add(builder);
@@ -109,6 +116,12 @@
         return packages;
     }
 
+    /**
+     * Sets the package names to be recursively searched for Java classes 
which extend [EMAIL PROTECTED] RouteBuilder} to be auto-wired up to the
+     * [EMAIL PROTECTED] SpringCamelContext} as a route. Note that classes are 
excluded if they are specifically configured in the spring.xml
+     *
+     * @param packages the package names which are recursively searched
+     */
     public void setPackages(String[] packages) {
         this.packages = packages;
     }