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

Author: wso2-jenkins-bot

README.md

@@ -18,26 +18,32 @@ 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-list/api/"></a>.
+Latest API Docs is <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api/1.0.0">1.0.0</a>.
 
 ## Features
 
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api//#collect-aggregate-function">collect</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;">Collect multiple values to construct a list.</p></p></div>
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api//#merge-aggregate-function">merge</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;">Collect multiple list to merge as a single list.</p></p></div>
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api//#add-function">add</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;">Function returns the updated list after adding the given value.</p></p></div>
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api//#addall-function">addAll</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;">Function returns the updated list after adding all the values from another list.</p></p></div>
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api//#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;">Function checks if the list contains the value.</p></p></div>
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api//#containsall-function">containsAll</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;">Function checks if the list contains all the values.</p></p></div>
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api//#create-function">create</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;">Function creates a list of all values.</p></p></div>
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api//#get-function">get</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;">Function returns the value at the specific index, null if index is out of range.</p></p></div>
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api//#indexof-function">indexOf</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;">Function returns the last index of the given element.</p></p></div>
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api//#isempty-function">isEmpty</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;">Function checks if the list is empty.</p></p></div>
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api//#islist-function">isList</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;">Function checks if the object is type of a list.</p></p></div>
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api//#lastindexof-function">lastIndexOf</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;">Function returns the index of the given value.</p></p></div>
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api//#remove-function">remove</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;">Function returns the updated list after removing the element with the specified value.</p></p></div>
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api//#removeall-function">removeAll</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;">Function returns the updated list after removing all the element with the specified list.</p></p></div>
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api//#size-function">size</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;">Function to return the size of the list.</p></p></div>
-* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api//#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;">Tokenize the list and return each key, value as new attributes in events</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api/1.0.0/#collect-aggregate-function">collect</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;">Collects multiple values to construct a list.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api/1.0.0/#merge-aggregate-function">merge</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;">Collects multiple lists to merge as a single list.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api/1.0.0/#add-function">add</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;">Function returns the updated list after adding the given value.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api/1.0.0/#addall-function">addAll</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;">Function returns the updated list after adding all the values from the given list.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api/1.0.0/#clear-function">clear</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;">Function returns the cleared list. </p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api/1.0.0/#clone-function">clone</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;">Function returns the cloned list.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api/1.0.0/#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;">Function checks whether the list contains the specific value.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api/1.0.0/#containsall-function">containsAll</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;">Function checks whether the list contains all the values in the given list.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api/1.0.0/#create-function">create</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;">Function creates a list containing all values provided.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api/1.0.0/#get-function">get</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;">Function returns the value at the specific index, null if index is out of range.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api/1.0.0/#indexof-function">indexOf</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;">Function returns the last index of the given element.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api/1.0.0/#isempty-function">isEmpty</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;">Function checks if the list is empty.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api/1.0.0/#islist-function">isList</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;">Function checks if the object is type of a list.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api/1.0.0/#lastindexof-function">lastIndexOf</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;">Function returns the index of the given value.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api/1.0.0/#remove-function">remove</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;">Function returns the updated list after removing the element with the specified value.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api/1.0.0/#removeall-function">removeAll</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;">Function returns the updated list after removing all the element with the specified list.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api/1.0.0/#removebyindex-function">removeByIndex</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;">Function returns the updated list after removing the element with the specified index.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api/1.0.0/#retainall-function">retainAll</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;">Function returns the updated list after retaining all the elements in the specified list.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api/1.0.0/#setvalue-function">setValue</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;">Function returns the updated list after replacing the element in the given index by the given value.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api/1.0.0/#size-function">size</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;">Function to return the size of the list.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api/1.0.0/#sort-function">sort</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;">Function returns lists sorted in ascending or descending order.</p></p></div>
+* <a target="_blank" href="https://siddhi-io.github.io/siddhi-execution-list/api/1.0.0/#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;">Tokenize the list and return each key, value as new attributes in events</p></p></div>
 
 ## Dependencies