json.get

 This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
 This article needs: Examples for the new functionality.

json.get() Function

• Introduced in version 1.3b49

Returns the value in a JSON Array at the specified index, returns a slice of a JSON Array from the specified indexes, or returns the value from JSON Object for the specified key.

Usage

json.get(array, index)

json.get(array, start, end)

json.get(object, key, key, ...)

Parameters

• array - The JSON Array to retrieve the element from.
• index - The numerical index of the element you want returned.
• start - The starting index of the element you wish the slice to begin at.
• end - The ending index of the element you wish the slice to end at.
• object - The JSON Object to retrieve the element from.
• key - The name of a field that should be returned. This parameter can exist more than once, if it does then a JSON Object is returned with all the specified elements.

Negative numbers can be used as the offsets from the end of the array, -1 is the last element in the array, -2 is the second to last, and so on. If the end index is smaller than the start index then the array slice is returned in reverse.

Examples

  a) [h: jo = json.fromStrProp("a=1; b=44; cat=12")] [r: json.get(jo, "b")]
  b) [h: jo = json.fromStrProp("a=1; b=44; cat=12")] [r: json.get(jo, "XX")]
  c) [h: jo = json.fromStrProp("a=1; b=44; cat=12")] [r: json.get(jo, "b", "a")]
  d) [h: jo = json.fromStrProp("a=1; b=44; cat=12")] [r: json.get(jo, "b", "XX")]
  e) [h: ja = json.fromList("1,44,12")] [r: json.get(ja, 1)]
  f) [h: ja = json.fromList("1,44,12")] [r: json.get(ja, 7)]
  g) [h: jo = json.fromStrProp("a=1; b=44; cat=12")] [r: json.get(jo, 1, 3)]

Returns

 a) 44
 b) empty string as XX does not exist -- ""
 c) a JSON object -- {"b":44,"a":1}
 d) a JSON object -- {"b":44,"XX":""}
 e) 44
 f) code error -- java.lang.ArrayIndexOutOfBoundsException

g) a JSON object -- {"3":"","1":""}

Version Changes

• 1.3b51 - Added ability to return JSON Array slices.
• 1.3b51 - Added ability to return JSON Objects of select fields from other JSON Objects.