Author: gertv
Date: Wed Dec 1 10:40:31 2010
New Revision: 1040938
URL: http://svn.apache.org/viewvc?rev=1040938&view=rev
Log:
Add better javadocs to improve generated wiki/xsd documentation
Modified:
servicemix/components/engines/servicemix-bean/trunk/pom.xml
servicemix/components/engines/servicemix-bean/trunk/src/main/java/org/apache/servicemix/bean/BeanEndpoint.java
Modified: servicemix/components/engines/servicemix-bean/trunk/pom.xml
URL:
http://svn.apache.org/viewvc/servicemix/components/engines/servicemix-bean/trunk/pom.xml?rev=1040938&r1=1040937&r2=1040938&view=diff
==============================================================================
--- servicemix/components/engines/servicemix-bean/trunk/pom.xml (original)
+++ servicemix/components/engines/servicemix-bean/trunk/pom.xml Wed Dec 1
10:40:31 2010
@@ -149,6 +149,13 @@
<artifactId>easymock</artifactId>
<scope>test</scope>
</dependency>
+
+ <!-- documentation -->
+ <dependency>
+ <groupId>org.apache.servicemix</groupId>
+ <artifactId>servicemix-common</artifactId>
+ <classifier>sources</classifier>
+ </dependency>
</dependencies>
<build>
Modified:
servicemix/components/engines/servicemix-bean/trunk/src/main/java/org/apache/servicemix/bean/BeanEndpoint.java
URL:
http://svn.apache.org/viewvc/servicemix/components/engines/servicemix-bean/trunk/src/main/java/org/apache/servicemix/bean/BeanEndpoint.java?rev=1040938&r1=1040937&r2=1040938&view=diff
==============================================================================
---
servicemix/components/engines/servicemix-bean/trunk/src/main/java/org/apache/servicemix/bean/BeanEndpoint.java
(original)
+++
servicemix/components/engines/servicemix-bean/trunk/src/main/java/org/apache/servicemix/bean/BeanEndpoint.java
Wed Dec 1 10:40:31 2010
@@ -131,6 +131,12 @@ public class BeanEndpoint extends Provid
return applicationContext;
}
+ /**
+ * Set the Spring ApplicationContext where the bean can be found.
Defaults to the context defined in xbean.xml
+ *
+ * @param applicationContext
+ * @throws BeansException
+ */
public void setApplicationContext(ApplicationContext applicationContext)
throws BeansException {
this.applicationContext = applicationContext;
}
@@ -139,6 +145,11 @@ public class BeanEndpoint extends Provid
return beanName;
}
+ /**
+ * Set the name of the bean in the application context to be used for
handling exchanges
+ *
+ * @param beanName
+ */
public void setBeanName(String beanName) {
this.beanName = beanName;
}
@@ -147,6 +158,11 @@ public class BeanEndpoint extends Provid
return bean;
}
+ /**
+ * Set the bean to be used for handling exchanges
+ *
+ * @param bean
+ */
public void setBean(Object bean) {
this.bean = bean;
}
@@ -159,6 +175,8 @@ public class BeanEndpoint extends Provid
}
/**
+ * Set the bean class to be used for handling exchanges. A new instance
will be created on the fly for every exchange.
+ *
* @param beanType the beanType to set
*/
public void setBeanType(Class<?> beanType) {
@@ -173,6 +191,8 @@ public class BeanEndpoint extends Provid
}
/**
+ * Set the bean class name to be used for handling exchanges. A new
instance will be created on the fly for every exchange.
+ *
* @param beanClassName the beanClassName to set
*/
public void setBeanClassName(String beanClassName) {
@@ -187,6 +207,11 @@ public class BeanEndpoint extends Provid
return beanInfo;
}
+ /**
+ * Set a custom bean info object to define the bean to be used for
handling exchanges
+ *
+ * @param beanInfo
+ */
public void setBeanInfo(BeanInfo beanInfo) {
this.beanInfo = beanInfo;
}
@@ -198,6 +223,11 @@ public class BeanEndpoint extends Provid
return methodInvocationStrategy;
}
+ /**
+ * Set a custom invocation strategy to define how the bean is being
invoked. The default implementation takes some additional parameter
annotations into account.
+ *
+ * @param methodInvocationStrategy the strategy
+ */
public void setMethodInvocationStrategy(MethodInvocationStrategy
methodInvocationStrategy) {
this.methodInvocationStrategy = methodInvocationStrategy;
}
@@ -500,6 +530,9 @@ public class BeanEndpoint extends Provid
}
/**
+ * Set a custom expression to use for correlating exchanges into a single
request handled by the same bean instance.
+ * The default expression uses a correlation ID set on the exchange
properties.
+ *
* @param correlationExpression the correlationExpression to set
*/
public void
setCorrelationExpression(org.apache.servicemix.expression.Expression
correlationExpression) {
