Skip to content

Commit

Permalink
[WSO2-Release] [Release 5.0.2] update documentation for release 5.0.2
Browse files Browse the repository at this point in the history
  • Loading branch information
@wso2-jenkins-bot
wso2-jenkins-bot committed May 27, 2019
1 parent 78fead6 commit b9932a5
Show file tree
Hide file tree
Showing 5 changed files with 460 additions and 23 deletions.
22 changes: 11 additions & 11 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Find some useful links below:

## Latest API Docs

Latest API Docs is <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-map/api/5.0.1">5.0.1</a>.
Latest API Docs is <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-map/api/5.0.2">5.0.2</a>.

## How to use

Expand Down Expand Up @@ -46,16 +46,16 @@ directory.

## Features

* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-map/api/5.0.1/#create-function">create</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This creates a map between the keys and their corresponding values.</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-map/api/5.0.1/#createfromjson-function">createFromJSON</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This returns the map created by pairing the keys with its corresponding values given in the JSON string.</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-map/api/5.0.1/#createfromxml-function">createFromXML</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This returns the map created by pairing the keys with their corresponding values,given as an XML string.</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-map/api/5.0.1/#get-function">get</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This returns the value object, that corresponds to the given key, from the map. </p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-map/api/5.0.1/#ismap-function">isMap</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This returns 'true' if the object is a map and 'false' if otherwise.</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-map/api/5.0.1/#put-function">put</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This returns the updated map after adding the given key-value pair.</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-map/api/5.0.1/#putall-function">putAll</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This returns the updated 'to.map' map after copying all of the mappings from the specified 'from.map.' map. If there are duplicate keys, 'from.map' overwrites the values into the 'to.map.' map.</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-map/api/5.0.1/#remove-function">remove</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This returns the updated map after removing the element with the key specified.</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-map/api/5.0.1/#tojson-function">toJSON</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This converts a map into a JSON object and returns the definition of that JSON object as a string.</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-map/api/5.0.1/#toxml-function">toXML</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This returns the map as an XML string.</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-map/api/5.0.2/#create-function">create</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This creates a map between the keys and their corresponding values.</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-map/api/5.0.2/#createfromjson-function">createFromJSON</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This returns the map created by pairing the keys with its corresponding values given in the JSON string.</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-map/api/5.0.2/#createfromxml-function">createFromXML</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This returns the map created by pairing the keys with their corresponding values,given as an XML string.</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-map/api/5.0.2/#get-function">get</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This returns the value object, that corresponds to the given key, from the map. </p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-map/api/5.0.2/#ismap-function">isMap</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This returns 'true' if the object is a map and 'false' if otherwise.</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-map/api/5.0.2/#put-function">put</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This returns the updated map after adding the given key-value pair.</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-map/api/5.0.2/#putall-function">putAll</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This returns the updated 'to.map' map after copying all of the mappings from the specified 'from.map.' map. If there are duplicate keys, 'from.map' overwrites the values into the 'to.map.' map.</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-map/api/5.0.2/#remove-function">remove</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This returns the updated map after removing the element with the key specified.</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-map/api/5.0.2/#tojson-function">toJSON</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This converts a map into a JSON object and returns the definition of that JSON object as a string.</p></div>
* <a target="_blank" href="https://wso2-extensions.github.io/siddhi-execution-map/api/5.0.2/#toxml-function">toXML</a> *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#function">(Function)</a>*<br><div style="padding-left: 1em;"><p>This returns the map as an XML string.</p></div>

## How to Contribute

Expand Down
Loading

0 comments on commit b9932a5

Please sign in to comment.