[WSO2-Release] [Release 5.0.8] update documentation for release 5.0.8

Author: wso2-jenkins-bot

README.md

@@ -19,32 +19,33 @@ For information on <a target="_blank" href="https://siddhi.io/">Siddhi</a> and i
 
 ## Latest API Docs 
 
-Latest API Docs is <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.7">5.0.7</a>.
+Latest API Docs is <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.8">5.0.8</a>.
 
 ## Features
 
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.7/#groupconcat-aggregate-function">groupConcat</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#aggregate-function">Aggregate Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This function aggregates the received events by concatenating the keys in those events using a separator, e.g.,a comma (,) or a hyphen (-), and returns the concatenated key string.</p></p></div>
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.7/#charat-function">charAt</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This function returns the 'char' value that is present at the given index position. of the input string.</p></p></div>
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.7/#coalesce-function">coalesce</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;"> This returns the first input parameter value of the given argument, that is not null.</p></p></div>
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.7/#concat-function">concat</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This function returns a string value that is obtained as a result of concatenating two or more input string values.</p></p></div>
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.7/#contains-function">contains</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This function returns <code>true</code> if the<code>input.string</code> contains the specified sequence of char values in the <code>search.string</code>. </p></p></div>
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.7/#equalsignorecase-function">equalsIgnoreCase</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This returns a boolean value by comparing two strings lexicographically without considering the letter case.</p></p></div>
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.7/#filltemplate-function">fillTemplate</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">fillTemplate(string, map) will replace all the keys in the string using values in the map. fillTemplate(string, r1, r2 ..) replace all the entries {{1}}, {{2}}, {{3}} with r1 , r2, r3.</p></p></div>
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.7/#hex-function">hex</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This function returns a hexadecimal string by converting each byte of each character in the input string to two hexadecimal digits.</p></p></div>
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.7/#length-function">length</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Returns the length of the input string.</p></p></div>
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.7/#lower-function">lower</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Converts the capital letters in the input string to the equivalent simple letters.</p></p></div>
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.7/#regexp-function">regexp</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Returns a boolean value based on the matchability of the input string and the given regular expression.</p></p></div>
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.7/#repeat-function">repeat</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Repeats the input string for a specified number of times.</p></p></div>
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.7/#replaceall-function">replaceAll</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Finds all the substrings of the input string that matches with the given expression, and replaces them with the given replacement string.</p></p></div>
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.7/#replacefirst-function">replaceFirst</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Finds the first substring of the input string that matches with the given regular expression, and replaces itwith the given replacement string.</p></p></div>
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.7/#reverse-function">reverse</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Returns the input string in the reverse order character-wise and string-wise.</p></p></div>
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.7/#split-function">split</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Splits the  <code>input.string</code> into substrings using the value parsed in the <code>split.string</code> and returns the substring at the position specified in the <code>group.number</code>.</p></p></div>
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.7/#strcmp-function">strcmp</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Compares two strings lexicographically and returns an integer value. If both strings are equal, 0 is returned. If  the first string is lexicographically greater than the second string, a positive value is returned. If the first string is lexicographically greater than the second string, a negative value is returned.</p></p></div>
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.7/#substr-function">substr</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Returns a substring of the input string by considering a subset or all of the following factors: starting index, length, regular expression, and regex group number.</p></p></div>
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.7/#trim-function">trim</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Returns a copy of the input string without the leading and trailing whitespace (if any).</p></p></div>
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.7/#unhex-function">unhex</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Returns a string by converting the hexadecimal characters in the input string.</p></p></div>
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.7/#upper-function">upper</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Converts the simple letters in the input string to the equivalent capital/block letters.</p></p></div>
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.7/#tokenize-stream-processor">tokenize</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#stream-processor">Stream Processor</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This function splits the input string into tokens using a given regular expression and returns the split tokens.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.8/#groupconcat-aggregate-function">groupConcat</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#aggregate-function">Aggregate Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This function aggregates the received events by concatenating the keys in those events using a separator, e.g.,a comma (,) or a hyphen (-), and returns the concatenated key string.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.8/#charat-function">charAt</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This function returns the 'char' value that is present at the given index position. of the input string.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.8/#charfrequency-function">charFrequency</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Gives the frequency of a char in <code>input string</code>.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.8/#coalesce-function">coalesce</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;"> This returns the first input parameter value of the given argument, that is not null.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.8/#concat-function">concat</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This function returns a string value that is obtained as a result of concatenating two or more input string values.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.8/#contains-function">contains</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This function returns <code>true</code> if the<code>input.string</code> contains the specified sequence of char values in the <code>search.string</code>. </p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.8/#equalsignorecase-function">equalsIgnoreCase</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This returns a boolean value by comparing two strings lexicographically without considering the letter case.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.8/#filltemplate-function">fillTemplate</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">fillTemplate(string, map) will replace all the keys in the string using values in the map. fillTemplate(string, r1, r2 ..) replace all the entries {{1}}, {{2}}, {{3}} with r1 , r2, r3.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.8/#hex-function">hex</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This function returns a hexadecimal string by converting each byte of each character in the input string to two hexadecimal digits.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.8/#length-function">length</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Returns the length of the input string.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.8/#lower-function">lower</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Converts the capital letters in the input string to the equivalent simple letters.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.8/#regexp-function">regexp</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Returns a boolean value based on the matchability of the input string and the given regular expression.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.8/#repeat-function">repeat</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Repeats the input string for a specified number of times.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.8/#replaceall-function">replaceAll</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Finds all the substrings of the input string that matches with the given expression, and replaces them with the given replacement string.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.8/#replacefirst-function">replaceFirst</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Finds the first substring of the input string that matches with the given regular expression, and replaces itwith the given replacement string.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.8/#reverse-function">reverse</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Returns the input string in the reverse order character-wise and string-wise.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.8/#split-function">split</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Splits the  <code>input.string</code> into substrings using the value parsed in the <code>split.string</code> and returns the substring at the position specified in the <code>group.number</code>.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.8/#strcmp-function">strcmp</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Compares two strings lexicographically and returns an integer value. If both strings are equal, 0 is returned. If  the first string is lexicographically greater than the second string, a positive value is returned. If the first string is lexicographically greater than the second string, a negative value is returned.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.8/#substr-function">substr</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Returns a substring of the input string by considering a subset or all of the following factors: starting index, length, regular expression, and regex group number.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.8/#trim-function">trim</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Returns a copy of the input string without the leading and trailing whitespace (if any).</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.8/#unhex-function">unhex</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Returns a string by converting the hexadecimal characters in the input string.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.8/#upper-function">upper</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#function">Function</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">Converts the simple letters in the input string to the equivalent capital/block letters.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-string/api/5.0.8/#tokenize-stream-processor">tokenize</a> *(<a target="_blank" href="http://siddhi.io/en/v5.1/docs/query-guide/#stream-processor">Stream Processor</a>)*<br> <div style="padding-left: 1em;"><p><p style="word-wrap: break-word;margin: 0;">This function splits the input string into tokens using a given regular expression and returns the split tokens.</p></p></div>
 
 ## Dependencies