You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2015/04/24 14:10:44 UTC

[3/6] camel git commit: Component doc

Component doc


Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/429b3542
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/429b3542
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/429b3542

Branch: refs/heads/master
Commit: 429b354220b83721be260af54b7ec0c5d22d2184
Parents: 525b56b
Author: Claus Ibsen <da...@apache.org>
Authored: Fri Apr 24 13:50:23 2015 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Fri Apr 24 13:50:23 2015 +0200

----------------------------------------------------------------------
 .../camel/component/xquery/XQueryComponent.java |  3 ++
 .../camel/component/xquery/XQueryEndpoint.java  | 36 ++++++++++++++++++++
 2 files changed, 39 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/429b3542/components/camel-saxon/src/main/java/org/apache/camel/component/xquery/XQueryComponent.java
----------------------------------------------------------------------
diff --git a/components/camel-saxon/src/main/java/org/apache/camel/component/xquery/XQueryComponent.java b/components/camel-saxon/src/main/java/org/apache/camel/component/xquery/XQueryComponent.java
index 2047c4d..0f3be86 100644
--- a/components/camel-saxon/src/main/java/org/apache/camel/component/xquery/XQueryComponent.java
+++ b/components/camel-saxon/src/main/java/org/apache/camel/component/xquery/XQueryComponent.java
@@ -54,6 +54,9 @@ public class XQueryComponent extends UriEndpointComponent {
         return moduleURIResolver;
     }
 
+    /**
+     * To use the custom {@link ModuleURIResolver}
+     */
     public void setModuleURIResolver(ModuleURIResolver moduleURIResolver) {
         this.moduleURIResolver = moduleURIResolver;
     }

http://git-wip-us.apache.org/repos/asf/camel/blob/429b3542/components/camel-saxon/src/main/java/org/apache/camel/component/xquery/XQueryEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-saxon/src/main/java/org/apache/camel/component/xquery/XQueryEndpoint.java b/components/camel-saxon/src/main/java/org/apache/camel/component/xquery/XQueryEndpoint.java
index 1a23db9..d38c89c 100644
--- a/components/camel-saxon/src/main/java/org/apache/camel/component/xquery/XQueryEndpoint.java
+++ b/components/camel-saxon/src/main/java/org/apache/camel/component/xquery/XQueryEndpoint.java
@@ -75,6 +75,9 @@ public class XQueryEndpoint extends ProcessorEndpoint {
         return resourceUri;
     }
 
+    /**
+     * The name of the template to load from classpath or file system
+     */
     public void setResourceUri(String resourceUri) {
         this.resourceUri = resourceUri;
     }
@@ -83,6 +86,9 @@ public class XQueryEndpoint extends ProcessorEndpoint {
         return configuration;
     }
 
+    /**
+     * To use a custom Saxon configuration
+     */
     public void setConfiguration(Configuration configuration) {
         this.configuration = configuration;
     }
@@ -91,6 +97,9 @@ public class XQueryEndpoint extends ProcessorEndpoint {
         return staticQueryContext;
     }
 
+    /**
+     * To use a custom Saxon StaticQueryContext
+     */
     public void setStaticQueryContext(StaticQueryContext staticQueryContext) {
         this.staticQueryContext = staticQueryContext;
     }
@@ -99,6 +108,9 @@ public class XQueryEndpoint extends ProcessorEndpoint {
         return parameters;
     }
 
+    /**
+     * Additional parameters
+     */
     public void setParameters(Map<String, Object> parameters) {
         this.parameters = parameters;
     }
@@ -107,6 +119,9 @@ public class XQueryEndpoint extends ProcessorEndpoint {
         return namespacePrefixes;
     }
 
+    /**
+     * Allows to control which namespace prefixes to use for a set of namespace mappings
+     */
     public void setNamespacePrefixes(Map<String, String> namespacePrefixes) {
         this.namespacePrefixes = namespacePrefixes;
     }
@@ -115,6 +130,9 @@ public class XQueryEndpoint extends ProcessorEndpoint {
         return resultsFormat;
     }
 
+    /**
+     * What output result to use
+     */
     public void setResultsFormat(ResultFormat resultsFormat) {
         this.resultsFormat = resultsFormat;
     }
@@ -123,6 +141,9 @@ public class XQueryEndpoint extends ProcessorEndpoint {
         return properties;
     }
 
+    /**
+     * Properties to configure the serialization parameters
+     */
     public void setProperties(Properties properties) {
         this.properties = properties;
     }
@@ -131,6 +152,9 @@ public class XQueryEndpoint extends ProcessorEndpoint {
         return resultType;
     }
 
+    /**
+     * What output result to use defined as a class
+     */
     public void setResultType(Class<?> resultType) {
         this.resultType = resultType;
     }
@@ -139,6 +163,9 @@ public class XQueryEndpoint extends ProcessorEndpoint {
         return stripsAllWhiteSpace;
     }
 
+    /**
+     * Whether to strip all whitespaces
+     */
     public void setStripsAllWhiteSpace(boolean stripsAllWhiteSpace) {
         this.stripsAllWhiteSpace = stripsAllWhiteSpace;
     }
@@ -147,6 +174,9 @@ public class XQueryEndpoint extends ProcessorEndpoint {
         return moduleURIResolver;
     }
 
+    /**
+     * To use the custom {@link ModuleURIResolver}
+     */
     public void setModuleURIResolver(ModuleURIResolver moduleURIResolver) {
         this.moduleURIResolver = moduleURIResolver;
     }
@@ -155,6 +185,9 @@ public class XQueryEndpoint extends ProcessorEndpoint {
         return allowStAX;
     }
 
+    /**
+     * Whether to allow using StAX mode
+     */
     public void setAllowStAX(boolean allowStAX) {
         this.allowStAX = allowStAX;
     }
@@ -163,6 +196,9 @@ public class XQueryEndpoint extends ProcessorEndpoint {
         return headerName;
     }
 
+    /**
+     * To use a Camel Message header as the input source instead of Message body.
+     */
     public void setHeaderName(String headerName) {
         this.headerName = headerName;
     }