diff --git a/README.md b/README.md index 1e0a426..9278505 100755 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Find some useful links below: ## Latest API Docs -Latest API Docs is 5.0.1. +Latest API Docs is 5.0.2. ## How to use @@ -46,16 +46,16 @@ directory. ## Features -* create *(Function)*

This creates a map between the keys and their corresponding values.

-* createFromJSON *(Function)*

This returns the map created by pairing the keys with its corresponding values given in the JSON string.

-* createFromXML *(Function)*

This returns the map created by pairing the keys with their corresponding values,given as an XML string.

-* get *(Function)*

This returns the value object, that corresponds to the given key, from the map.

-* isMap *(Function)*

This returns 'true' if the object is a map and 'false' if otherwise.

-* put *(Function)*

This returns the updated map after adding the given key-value pair.

-* putAll *(Function)*

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.

-* remove *(Function)*

This returns the updated map after removing the element with the key specified.

-* toJSON *(Function)*

This converts a map into a JSON object and returns the definition of that JSON object as a string.

-* toXML *(Function)*

This returns the map as an XML string.

+* create *(Function)*

This creates a map between the keys and their corresponding values.

+* createFromJSON *(Function)*

This returns the map created by pairing the keys with its corresponding values given in the JSON string.

+* createFromXML *(Function)*

This returns the map created by pairing the keys with their corresponding values,given as an XML string.

+* get *(Function)*

This returns the value object, that corresponds to the given key, from the map.

+* isMap *(Function)*

This returns 'true' if the object is a map and 'false' if otherwise.

+* put *(Function)*

This returns the updated map after adding the given key-value pair.

+* putAll *(Function)*

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.

+* remove *(Function)*

This returns the updated map after removing the element with the key specified.

+* toJSON *(Function)*

This converts a map into a JSON object and returns the definition of that JSON object as a string.

+* toXML *(Function)*

This returns the map as an XML string.

## How to Contribute diff --git a/docs/api/5.0.2.md b/docs/api/5.0.2.md new file mode 100644 index 0000000..048a053 --- /dev/null +++ b/docs/api/5.0.2.md @@ -0,0 +1,436 @@ +# API Docs - v5.0.2 + +## Map + +### create *(Function)* + +

This creates a map between the keys and their corresponding values.

+ +Syntax +``` + map:create( key1, value1, key2, value2) +``` + +QUERY PARAMETERS + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionDefault ValuePossible Data TypesOptionalDynamic
key1key 1OBJECTNoNo
value1Value 1OBJECTNoNo
key2Key 2OBJECTNoNo
value2Value 2OBJECTNoNo
+ +Examples +EXAMPLE 1 +``` +create(1 , ?one? , 2 , ?two? , 3 , ?three?) +``` +

This returns a map with keys 1, 2, 3 mapped with their corresponding values, "one", "two", "three".

+ +### createFromJSON *(Function)* + +

This returns the map created by pairing the keys with its corresponding values given in the JSON string.

+ +Syntax +``` + map:createFromJSON( json.string) +``` + +QUERY PARAMETERS + + + + + + + + + + + + + + + + + +
NameDescriptionDefault ValuePossible Data TypesOptionalDynamic
json.stringJSON as a string, which is used to create the map.STRINGNoNo
+ +Examples +EXAMPLE 1 +``` +createFromJSON(?{?symbol' : 'IBM' , 'price' : 200, 'volume' : 100}?) +``` +

This returns a map with the keys "symbol", "price", "volume", and its values, "IBM", 200 and 100 respectively.

+ +### createFromXML *(Function)* + +

This returns the map created by pairing the keys with their corresponding values,given as an XML string.

+ +Syntax +``` + map:createFromXML( xml.string) +``` + +QUERY PARAMETERS + + + + + + + + + + + + + + + + + +
NameDescriptionDefault ValuePossible Data TypesOptionalDynamic
xml.stringThe XML string, which is used to create the map.STRINGNoNo
+ +Examples +EXAMPLE 1 +``` +createFromJSON(?{?symbol' : 'IBM' , 'price' : 200, 'volume' : 100}?) +``` +

returns a map with the keys "symbol", "price", "volume", and with the values "IBM", 200 and 100 respectively.

+ +### get *(Function)* + +

This returns the value object, that corresponds to the given key, from the map.

+ +Syntax +``` + map:get( map, key) +``` + +QUERY PARAMETERS + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionDefault ValuePossible Data TypesOptionalDynamic
mapThe map from where the value should be obtainedOBJECTNoNo
keyThe key of the value which needs to be returnedOBJECTNoNo
+ +Examples +EXAMPLE 1 +``` +get(company,1) +``` +

This function returns the value that is associated with the key, i.e., 1, from a map named company.

+ +### isMap *(Function)* + +

This returns 'true' if the object is a map and 'false' if otherwise.

+ +Syntax +``` + map:isMap( object) +``` + +QUERY PARAMETERS + + + + + + + + + + + + + + + + + +
NameDescriptionDefault ValuePossible Data TypesOptionalDynamic
objectThe object that the function checks to determine whether it's a map or not.OBJECTNoNo
+ +Examples +EXAMPLE 1 +``` +isMap(students) +``` +

This function returns 'true' if the object, students is a map. It returns 'false' if it is not a map.

+ +### put *(Function)* + +

This returns the updated map after adding the given key-value pair.

+ +Syntax +``` + map:put( map, key, value) +``` + +QUERY PARAMETERS + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionDefault ValuePossible Data TypesOptionalDynamic
mapThe map to which the value should be added.OBJECTNoNo
keyThe key of the value added.OBJECTNoNo
valueThe new value.OBJECTNoNo
+ +Examples +EXAMPLE 1 +``` +put(students , 1234 , ?sam?) +``` +

This function returns the updated map named students after adding the object "sam" with key 1234.

+ +### putAll *(Function)* + +

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.

+ +Syntax +``` + map:putAll( to.map, from.map) +``` + +QUERY PARAMETERS + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionDefault ValuePossible Data TypesOptionalDynamic
to.mapThe map into which the mappings need to copied.OBJECTNoNo
from.mapThe map from which the mappings are copied.OBJECTNoNo
+ +Examples +EXAMPLE 1 +``` +putAll(toMap , fromMap) +``` +

This returns the updated map named 'toMap' after adding each mapping from 'fromMap.'

+ +### remove *(Function)* + +

This returns the updated map after removing the element with the key specified.

+ +Syntax +``` + map:remove( map, key) +``` + +QUERY PARAMETERS + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionDefault ValuePossible Data TypesOptionalDynamic
mapThe map that needs to be updated by removing the element.OBJECTNoNo
keyThe key of the element that needs to removed from the map.OBJECTNoNo
+ +Examples +EXAMPLE 1 +``` +remove(students , 1234) +``` +

This function returns the updated map, students after removing the element with the key 1234.

+ +### toJSON *(Function)* + +

This converts a map into a JSON object and returns the definition of that JSON object as a string.

+ +Syntax +``` + map:toJSON( map) +``` + +QUERY PARAMETERS + + + + + + + + + + + + + + + + + +
NameDescriptionDefault ValuePossible Data TypesOptionalDynamic
mapThe map that needs to be converted to JSONOBJECTNoNo
+ +Examples +EXAMPLE 1 +``` +toJSON(company) +``` +

If "company" is a map with key-value pairs, ("symbol" : wso2),("volume" : 100), and ("price",200), it returns the string ?{?symbol? : ?wso2?, ?volume? : 100 , ?price? : 200}?.

+ +### toXML *(Function)* + +

This returns the map as an XML string.

+ +Syntax +``` + map:toXML( map, rootelementname) +``` + +QUERY PARAMETERS + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionDefault ValuePossible Data TypesOptionalDynamic
mapThe map that needs to be converted to XML.OBJECTNoNo
rootelementnameThe root element of the map.nullOBJECTYesNo
+ +Examples +EXAMPLE 1 +``` +toXML(company, "abcCompany") +``` +

If "company" is a map with key-value pairs, (?symbol? : wso2), (?volume? : 100), and (?price? : 200), this function returns the string, ?<abcCompany><symbol>wso2</symbol><volume><100></volume><price>200</price></abcCompany>.

+ diff --git a/docs/api/latest.md b/docs/api/latest.md index 13f5e83..048a053 100644 --- a/docs/api/latest.md +++ b/docs/api/latest.md @@ -1,4 +1,4 @@ -# API Docs - v5.0.1 +# API Docs - v5.0.2 ## Map diff --git a/docs/index.md b/docs/index.md index 1e0a426..9278505 100755 --- a/docs/index.md +++ b/docs/index.md @@ -11,7 +11,7 @@ Find some useful links below: ## Latest API Docs -Latest API Docs is 5.0.1. +Latest API Docs is 5.0.2. ## How to use @@ -46,16 +46,16 @@ directory. ## Features -* create *(Function)*

This creates a map between the keys and their corresponding values.

-* createFromJSON *(Function)*

This returns the map created by pairing the keys with its corresponding values given in the JSON string.

-* createFromXML *(Function)*

This returns the map created by pairing the keys with their corresponding values,given as an XML string.

-* get *(Function)*

This returns the value object, that corresponds to the given key, from the map.

-* isMap *(Function)*

This returns 'true' if the object is a map and 'false' if otherwise.

-* put *(Function)*

This returns the updated map after adding the given key-value pair.

-* putAll *(Function)*

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.

-* remove *(Function)*

This returns the updated map after removing the element with the key specified.

-* toJSON *(Function)*

This converts a map into a JSON object and returns the definition of that JSON object as a string.

-* toXML *(Function)*

This returns the map as an XML string.

+* create *(Function)*

This creates a map between the keys and their corresponding values.

+* createFromJSON *(Function)*

This returns the map created by pairing the keys with its corresponding values given in the JSON string.

+* createFromXML *(Function)*

This returns the map created by pairing the keys with their corresponding values,given as an XML string.

+* get *(Function)*

This returns the value object, that corresponds to the given key, from the map.

+* isMap *(Function)*

This returns 'true' if the object is a map and 'false' if otherwise.

+* put *(Function)*

This returns the updated map after adding the given key-value pair.

+* putAll *(Function)*

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.

+* remove *(Function)*

This returns the updated map after removing the element with the key specified.

+* toJSON *(Function)*

This converts a map into a JSON object and returns the definition of that JSON object as a string.

+* toXML *(Function)*

This returns the map as an XML string.

## How to Contribute diff --git a/mkdocs.yml b/mkdocs.yml index 9b5e904..6482ef5 100755 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -32,6 +32,7 @@ markdown_extensions: pages: - Welcome: index.md - API Docs: + - 5.0.2: api/5.0.2.md - 5.0.1: api/5.0.1.md - 5.0.0: api/5.0.0.md - 4.1.0: api/4.1.0.md