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 2024/08/16 12:02:12 UTC
(camel) 10/13: CAMEL-20569: camel-catalog - Markup languages which functions they support for better doc and tooling.
This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch lan-markup
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 6e91a66400daba19a963d0305d3ed791292dbd31
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Fri Aug 16 12:02:42 2024 +0200
CAMEL-20569: camel-catalog - Markup languages which functions they support for better doc and tooling.
---
.../org/apache/camel/language/simple/simple.json | 18 +++++++++---------
.../camel/language/simple/SimpleConstants.java | 20 ++++++++++----------
2 files changed, 19 insertions(+), 19 deletions(-)
diff --git a/core/camel-core-languages/src/generated/resources/META-INF/org/apache/camel/language/simple/simple.json b/core/camel-core-languages/src/generated/resources/META-INF/org/apache/camel/language/simple/simple.json
index fe3c0073ccd..2d7b8645be1 100644
--- a/core/camel-core-languages/src/generated/resources/META-INF/org/apache/camel/language/simple/simple.json
+++ b/core/camel-core-languages/src/generated/resources/META-INF/org/apache/camel/language/simple/simple.json
@@ -62,16 +62,16 @@
"properties:key:default": { "index": 37, "kind": "function", "displayName": "Property Placeholder", "group": "function", "label": "function", "required": false, "javaType": "String", "prefix": "${", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Lookup a property placeholder with the given key. If the key does not exist nor has a value, then an optional default value can be specified.", "suffix": "}" },
"ref:name": { "index": 38, "kind": "function", "displayName": "Bean By Id", "group": "function", "label": "function", "required": false, "javaType": "Object", "prefix": "${", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "To look up a bean from the Registry with the given name.", "suffix": "}" },
"type:name.field": { "index": 39, "kind": "function", "displayName": "Java Field Value", "group": "function", "label": "function", "required": false, "javaType": "Object", "prefix": "${", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "To refer to a type or field by its classname. To refer to a field, you can append .FIELD_NAME. For example, you can refer to the constant field from Exchange as: `org.apache.camel.Exchange.FILE_NAME`", " [...]
- "replace(from,to,exp)": { "index": 40, "kind": "function", "displayName": "Replace", "group": "function", "label": "function", "required": false, "javaType": "String", "prefix": "${", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Replace all the string values in the message body\/expression. To make it easier to replace single and double quotes, then you can use XML escaped values `\\"` as double quote, `\\'` as single quot [...]
+ "replace(from,to,exp)": { "index": 40, "kind": "function", "displayName": "Replace String Values", "group": "function", "label": "function", "required": false, "javaType": "String", "prefix": "${", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Replace all the string values in the message body\/expression. To make it easier to replace single and double quotes, then you can use XML escaped values `\\"` as double quote, `\\'` [...]
"substring(head,tail)": { "index": 41, "kind": "function", "displayName": "Substring", "group": "function", "label": "function", "required": false, "javaType": "String", "prefix": "${", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Returns a substring of the message body\/expression. If only one positive number, then the returned string is clipped from the beginning. If only one negative number, then the returned string is clipped fr [...]
- "random(min,max)": { "index": 42, "kind": "function", "displayName": "Random", "group": "function", "label": "function", "required": false, "javaType": "int", "prefix": "${", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Returns a random number between min (included) and max (excluded).", "suffix": "}" },
- "skip(num)": { "index": 43, "kind": "function", "displayName": "Skip", "group": "function", "label": "function", "required": false, "javaType": "java.util.Iterator", "prefix": "${", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The skip function iterates the message body and skips the first number of items. This can be used with the Splitter EIP to split a message body and skip the first N number of items.", "suffix": "}" },
- "collate(num)": { "index": 44, "kind": "function", "displayName": "Collate", "group": "function", "label": "function", "required": false, "javaType": "java.util.Iterator", "prefix": "${", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The collate function iterates the message body and groups the data into sub lists of specified size. This can be used with the Splitter EIP to split a message body and group\/batch the split sub message [...]
+ "random(min,max)": { "index": 42, "kind": "function", "displayName": "Generate Random Number", "group": "function", "label": "function", "required": false, "javaType": "int", "prefix": "${", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Returns a random number between min (included) and max (excluded).", "suffix": "}" },
+ "skip(num)": { "index": 43, "kind": "function", "displayName": "Skip First Items from the Message Body", "group": "function", "label": "function", "required": false, "javaType": "java.util.Iterator", "prefix": "${", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The skip function iterates the message body and skips the first number of items. This can be used with the Splitter EIP to split a message body and skip the first N number of [...]
+ "collate(num)": { "index": 44, "kind": "function", "displayName": "Group Message Body into Sub Lists", "group": "function", "label": "function", "required": false, "javaType": "java.util.Iterator", "prefix": "${", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The collate function iterates the message body and groups the data into sub lists of specified size. This can be used with the Splitter EIP to split a message body and group\/ba [...]
"join(separator,prefix,exp)": { "index": 45, "kind": "function", "displayName": "Join", "group": "function", "label": "function", "required": false, "javaType": "String", "prefix": "${", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The join function iterates the message body\/expression and joins the data into a string. The separator is by default a comma. The prefix is optional. The join uses the message body as source by default. [...]
- "messageHistory(boolean)": { "index": 46, "kind": "function", "displayName": "Message History", "group": "function", "label": "function", "required": false, "javaType": "String", "prefix": "${", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The message history of the current exchange (how it has been routed). This is similar to the route stack-trace message history the error handler logs in case of an unhandled exception. The boolean [...]
- "uuid(type)": { "index": 47, "kind": "function", "displayName": "UUID", "group": "function", "label": "function", "required": false, "javaType": "String", "prefix": "${", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Returns a UUID using the Camel `UuidGenerator`. You can choose between `default`, `classic`, `short` and `simple` as the type. If no type is given, the default is used. It is also possible to use a custom `UuidGenerator` [...]
- "hash(exp,algorithm)": { "index": 48, "kind": "function", "displayName": "Hash", "group": "function", "label": "function", "required": false, "javaType": "String", "prefix": "${", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Returns a hashed value (string in hex decimal) of the message body\/expression using JDK MessageDigest. The algorithm can be SHA-256 (default) or SHA3-256.", "suffix": "}" },
- "empty(type)": { "index": 49, "kind": "function", "displayName": "Empty", "group": "function", "label": "function", "required": false, "javaType": "Object", "prefix": "${", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Creates a new empty object (decided by type). Use `string` to create an empty String. Use `list` to create an empty `java.util.ArrayList`. Use `map` to create an empty `java.util.HashMap`.", "suffix": "}" },
- "iif(predicate,trueExp,falseExp)": { "index": 50, "kind": "function", "displayName": "Iif", "group": "function", "label": "function", "required": false, "javaType": "Object", "prefix": "${", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Evaluates the predicate and returns the value of trueExp or falseExp. This function is similar to the ternary operator in Java.", "suffix": "}" }
+ "messageHistory(boolean)": { "index": 46, "kind": "function", "displayName": "Print Message History", "group": "function", "label": "function", "required": false, "javaType": "String", "prefix": "${", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The message history of the current exchange (how it has been routed). This is similar to the route stack-trace message history the error handler logs in case of an unhandled exception. The b [...]
+ "uuid(type)": { "index": 47, "kind": "function", "displayName": "Generate UUID", "group": "function", "label": "function", "required": false, "javaType": "String", "prefix": "${", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Returns a UUID using the Camel `UuidGenerator`. You can choose between `default`, `classic`, `short` and `simple` as the type. If no type is given, the default is used. It is also possible to use a custom `UuidG [...]
+ "hash(exp,algorithm)": { "index": 48, "kind": "function", "displayName": "Compute Hash Value", "group": "function", "label": "function", "required": false, "javaType": "String", "prefix": "${", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Returns a hashed value (string in hex decimal) of the message body\/expression using JDK MessageDigest. The algorithm can be SHA-256 (default) or SHA3-256.", "suffix": "}" },
+ "empty(type)": { "index": 49, "kind": "function", "displayName": "Create Empty Object", "group": "function", "label": "function", "required": false, "javaType": "Object", "prefix": "${", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Creates a new empty object (decided by type). Use `string` to create an empty String. Use `list` to create an empty `java.util.ArrayList`. Use `map` to create an empty `java.util.HashMap`.", "suffix": "}" },
+ "iif(predicate,trueExp,falseExp)": { "index": 50, "kind": "function", "displayName": "If Then Else", "group": "function", "label": "function", "required": false, "javaType": "Object", "prefix": "${", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Evaluates the predicate and returns the value of trueExp or falseExp. This function is similar to the ternary operator in Java.", "suffix": "}" }
}
}
diff --git a/core/camel-core-languages/src/main/java/org/apache/camel/language/simple/SimpleConstants.java b/core/camel-core-languages/src/main/java/org/apache/camel/language/simple/SimpleConstants.java
index 558bc88b905..fe14c98c6e8 100644
--- a/core/camel-core-languages/src/main/java/org/apache/camel/language/simple/SimpleConstants.java
+++ b/core/camel-core-languages/src/main/java/org/apache/camel/language/simple/SimpleConstants.java
@@ -156,7 +156,7 @@ public final class SimpleConstants {
public static final String TYPE = "type:name.field";
@Metadata(description = "Replace all the string values in the message body/expression."
+ " To make it easier to replace single and double quotes, then you can use XML escaped values `\\"` as double quote, `\\'` as single quote, and `\\∅` as empty value.",
- label = "function", javaType = "String")
+ label = "function", javaType = "String", displayName = "Replace String Values")
public static final String REPLACE = "replace(from,to,exp)";
@Metadata(description = "Returns a substring of the message body/expression."
+ " If only one positive number, then the returned string is clipped from the beginning."
@@ -165,16 +165,16 @@ public final class SimpleConstants {
label = "function", javaType = "String")
public static final String SUBSTRING = "substring(head,tail)";
@Metadata(description = "Returns a random number between min (included) and max (excluded).", label = "function",
- javaType = "int")
+ javaType = "int", displayName = "Generate Random Number")
public static final String RANDOM = "random(min,max)";
@Metadata(description = "The skip function iterates the message body and skips the first number of items."
+ " This can be used with the Splitter EIP to split a message body and skip the first N number of items.",
- label = "function", javaType = "java.util.Iterator")
+ label = "function", javaType = "java.util.Iterator", displayName = "Skip First Items from the Message Body")
public static final String SKIP = "skip(num)";
@Metadata(description = "The collate function iterates the message body and groups the data into sub lists of specified size."
+ " This can be used with the Splitter EIP to split a message body and group/batch"
+ " the split sub message into a group of N sub lists.",
- label = "function", javaType = "java.util.Iterator")
+ label = "function", javaType = "java.util.Iterator", displayName = "Group Message Body into Sub Lists")
public static final String COLLATE = "collate(num)";
@Metadata(description = "The join function iterates the message body/expression and joins the data into a string."
+ " The separator is by default a comma. The prefix is optional."
@@ -185,22 +185,22 @@ public final class SimpleConstants {
@Metadata(description = "The message history of the current exchange (how it has been routed). This is similar to the route stack-trace message history"
+ " the error handler logs in case of an unhandled exception."
+ " The boolean can be used to turn off detailed information to be less verbose, and avoid printing sensitive data from the message.",
- label = "function", javaType = "String")
+ label = "function", javaType = "String", displayName = "Print Message History")
public static final String MESSAGE_HISTORY = "messageHistory(boolean)";
@Metadata(description = "Returns a UUID using the Camel `UuidGenerator`."
+ " You can choose between `default`, `classic`, `short` and `simple` as the type."
+ " If no type is given, the default is used. It is also possible to use a custom `UuidGenerator`"
+ " and bind the bean to the xref:manual::registry.adoc[Registry] with an id. For example `${uuid(myGenerator)}`"
+ " where the ID is _myGenerator_.",
- label = "function", javaType = "String", displayName = "UUID")
+ label = "function", javaType = "String", displayName = "Generate UUID")
public static final String UUID = "uuid(type)";
@Metadata(description = "Returns a hashed value (string in hex decimal) of the message body/expression using JDK MessageDigest. The algorithm can be SHA-256 (default) or SHA3-256.",
- label = "function", javaType = "String")
+ label = "function", javaType = "String", displayName = "Compute Hash Value")
public static final String HASH = "hash(exp,algorithm)";
- @Metadata(description = "Creates a new empty object (decided by type). Use `string` to create an empty String. Use `list` to create an empty `java.util.ArrayList`. Use `map` to create an empty `java.util.HashMap`.",
- label = "function", javaType = "Object")
+ @Metadata(description = "Creates a new empty object (decided by type). Use `string` to create an empty String. Use `list` to create an empty `java.util.ArrayList`. Use `map` to create an empty `java.util.HashMap`.",
+ label = "function", javaType = "Object", displayName = "Create Empty Object")
public static final String EMPTY = "empty(type)";
@Metadata(description = "Evaluates the predicate and returns the value of trueExp or falseExp. This function is similar to the ternary operator in Java.",
- label = "function", javaType = "Object")
+ label = "function", javaType = "Object", displayName = "If Then Else")
public static final String IIF = "iif(predicate,trueExp,falseExp)";
}