Repository: camel Updated Branches: refs/heads/master ed166443d -> 47bae5e77
CAMEL-8195: Add javadoc to model classes so we have EIP documentation out of the box Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/47bae5e7 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/47bae5e7 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/47bae5e7 Branch: refs/heads/master Commit: 47bae5e77aa5064df41bb8bee5696d428031afec Parents: ed16644 Author: Claus Ibsen <davscl...@apache.org> Authored: Fri Jan 16 14:54:16 2015 +0100 Committer: Claus Ibsen <davscl...@apache.org> Committed: Fri Jan 16 14:54:16 2015 +0100 ---------------------------------------------------------------------- .../org/apache/camel/model/AOPDefinition.java | 15 +++++++++ .../org/apache/camel/model/BeanDefinition.java | 33 +++++++++++++++++--- 2 files changed, 44 insertions(+), 4 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/47bae5e7/camel-core/src/main/java/org/apache/camel/model/AOPDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/AOPDefinition.java b/camel-core/src/main/java/org/apache/camel/model/AOPDefinition.java index 312bf58..f096a82 100644 --- a/camel-core/src/main/java/org/apache/camel/model/AOPDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/AOPDefinition.java @@ -60,6 +60,9 @@ public class AOPDefinition extends OutputDefinition<AOPDefinition> { return beforeUri; } + /** + * Endpoint to call in AOP before. + */ public void setBeforeUri(String beforeUri) { this.beforeUri = beforeUri; } @@ -68,6 +71,12 @@ public class AOPDefinition extends OutputDefinition<AOPDefinition> { return afterUri; } + /** + * Endpoint to call in AOP after. + * <p/> + * The difference between after and afterFinally is that afterFinally is invoked from a finally block + * so it will always be invoked no matter what, eg also in case of an exception occur. + */ public void setAfterUri(String afterUri) { this.afterUri = afterUri; } @@ -76,6 +85,12 @@ public class AOPDefinition extends OutputDefinition<AOPDefinition> { return afterFinallyUri; } + /** + * Endpoint to call in AOP after finally. + * <p/> + * The difference between after and afterFinally is that afterFinally is invoked from a finally block + * so it will always be invoked no matter what, eg also in case of an exception occur. + */ public void setAfterFinallyUri(String afterFinallyUri) { this.afterFinallyUri = afterFinallyUri; } http://git-wip-us.apache.org/repos/asf/camel/blob/47bae5e7/camel-core/src/main/java/org/apache/camel/model/BeanDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/BeanDefinition.java b/camel-core/src/main/java/org/apache/camel/model/BeanDefinition.java index f78ee73..16ca814 100644 --- a/camel-core/src/main/java/org/apache/camel/model/BeanDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/BeanDefinition.java @@ -54,6 +54,7 @@ public class BeanDefinition extends NoOutputDefinition<BeanDefinition> { @XmlAttribute private Boolean cache; @XmlAttribute + @Deprecated private Boolean multiParameterArray; @XmlTransient private Class<?> beanClass; @@ -104,6 +105,9 @@ public class BeanDefinition extends NoOutputDefinition<BeanDefinition> { return ref; } + /** + * Sets a reference to a bean to use + */ public void setRef(String ref) { this.ref = ref; } @@ -112,10 +116,16 @@ public class BeanDefinition extends NoOutputDefinition<BeanDefinition> { return method; } + /** + * Sets the method name on the bean to use + */ public void setMethod(String method) { this.method = method; } + /** + * Sets an instance of the bean to use + */ public void setBean(Object bean) { this.bean = bean; } @@ -124,10 +134,16 @@ public class BeanDefinition extends NoOutputDefinition<BeanDefinition> { return beanType; } + /** + * Sets the Class of the bean + */ public void setBeanType(String beanType) { this.beanType = beanType; } + /** + * Sets the Class of the bean + */ public void setBeanType(Class<?> beanType) { this.beanClass = beanType; } @@ -136,6 +152,9 @@ public class BeanDefinition extends NoOutputDefinition<BeanDefinition> { return cache; } + /** + * Caches the bean lookup, to avoid lookup up bean on every usage. + */ public void setCache(Boolean cache) { this.cache = cache; } @@ -143,7 +162,13 @@ public class BeanDefinition extends NoOutputDefinition<BeanDefinition> { public Boolean getMultiParameterArray() { return multiParameterArray; } - + + /** + * Whether the message body is an array type. + * + * @deprecated is to be replaced with a better solution in Camel 3.0 + */ + @Deprecated public void setMultiParameterArray(Boolean multiParameterArray) { this.multiParameterArray = multiParameterArray; } @@ -151,7 +176,7 @@ public class BeanDefinition extends NoOutputDefinition<BeanDefinition> { // Fluent API //------------------------------------------------------------------------- /** - * Sets the ref String on camel bean + * Sets a reference to a bean to use * * @param ref the bean's id in the registry * @return the builder @@ -164,7 +189,7 @@ public class BeanDefinition extends NoOutputDefinition<BeanDefinition> { } /** - * Sets the calling method name of camel bean + * Sets the method name on the bean to use * * @param method the bean's method name which wants camel to call * @return the builder @@ -177,7 +202,7 @@ public class BeanDefinition extends NoOutputDefinition<BeanDefinition> { } /** - * Sets the bean's instance that camel to call + * Sets an instance of the bean to use * * @param bean the instance of the bean * @return the builder
