public class JsonSlurper
This has the same interface as the original JsonSlurper written for version 1.8.0, but its implementation has completely changed. It is now up to 20x faster than before, and its speed competes and often substantially exceeds popular common JSON parsers circa Jan, 2014.
JSON slurper parses text or reader content into a data structure of lists and maps.
Example usage:
JsonSlurper can use several types of JSON parsers. Please read the documentation for
JsonParserType. There are relaxed mode parsers, large file parser, and index overlay parsers.
Don't worry, it is all groovy. JsonSlurper will just work, but understanding the different parser
types may allow you to drastically improve the performance of your JSON parsing.
def slurper = new groovy.json.JsonSlurper()
def result = slurper.parseText('{"person":{"name":"Guillaume","age":33,"pets":["dog","cat"]}}')
assert result.person.name == "Guillaume"
assert result.person.age == 33
assert result.person.pets.size() == 2
assert result.person.pets[0] == "dog"
assert result.person.pets[1] == "cat"
parser = new JsonSlurper().setType(JsonParserType.INDEX_OVERLAY);
Type Params | Return Type | Name and description |
---|---|---|
|
int |
getMaxSizeForInMemory() Max size before Slurper starts to use windowing buffer parser. |
|
JsonParserType |
getType() Parser type. |
|
boolean |
isCheckDates() Determine if slurper will automatically parse strings it recognizes as dates. |
|
boolean |
isChop() Turns on buffer chopping for index overlay. |
|
boolean |
isLazyChop() Turns on buffer lazy chopping for index overlay. |
|
Object |
parse(Reader reader) Parse a JSON data structure from content from a reader |
|
Object |
parse(InputStream inputStream) Parse a JSON data structure from content from an inputStream |
|
Object |
parse(InputStream inputStream, String charset) Parse a JSON data structure from content from an inputStream |
|
Object |
parse(byte[] bytes, String charset) Parse a JSON data structure from content from a byte array. |
|
Object |
parse(byte[] bytes) Parse a JSON data structure from content from a byte array. |
|
Object |
parse(char[] chars) Parse a JSON data structure from content from a char array. |
|
Object |
parse(Path path) Parse a JSON data structure from content within a given Path. |
|
Object |
parse(Path path, String charset) Parse a JSON data structure from content within a given Path. |
|
Object |
parse(File file) Parse a JSON data structure from content within a given File. |
|
Object |
parse(File file, String charset) Parse a JSON data structure from content within a given File. |
|
Object |
parse(URL url) Parse a JSON data structure from content at a given URL. |
|
Object |
parse(URL url, Map params) Parse a JSON data structure from content at a given URL. |
|
Object |
parse(Map params, URL url) Parse a JSON data structure from content at a given URL. |
|
Object |
parse(URL url, String charset) Parse a JSON data structure from content at a given URL. |
|
Object |
parse(URL url, Map params, String charset) Parse a JSON data structure from content at a given URL. |
|
Object |
parse(Map params, URL url, String charset) Parse a JSON data structure from content at a given URL. |
|
Object |
parseText(String text) Parse a text representation of a JSON data structure |
|
JsonSlurper |
setCheckDates(boolean checkDates) Determine if slurper will automatically parse strings it recognizes as dates. |
|
JsonSlurper |
setChop(boolean chop) Turns on buffer chopping for index overlay. |
|
JsonSlurper |
setLazyChop(boolean lazyChop) Turns on buffer lazy chopping for index overlay. |
|
JsonSlurper |
setMaxSizeForInMemory(int maxSizeForInMemory) Max size before Slurper starts to use windowing buffer parser. |
|
JsonSlurper |
setType(JsonParserType type) Parser type. |
Max size before Slurper starts to use windowing buffer parser.
Parser type.
Determine if slurper will automatically parse strings it recognizes as dates. Index overlay only.
Turns on buffer chopping for index overlay.
Turns on buffer lazy chopping for index overlay.
Parse a JSON data structure from content from a reader
reader
- reader over a JSON contentParse a JSON data structure from content from an inputStream
inputStream
- stream over a JSON contentParse a JSON data structure from content from an inputStream
inputStream
- stream over a JSON contentcharset
- charsetParse a JSON data structure from content from a byte array.
bytes
- buffer of JSON contentcharset
- charsetParse a JSON data structure from content from a byte array.
bytes
- buffer of JSON contentParse a JSON data structure from content from a char array.
chars
- buffer of JSON contentParse a JSON data structure from content within a given Path.
path
- Path containing JSON contentParse a JSON data structure from content within a given Path.
path
- Path containing JSON contentcharset
- the charset for this FileParse a JSON data structure from content within a given File.
file
- File containing JSON contentParse a JSON data structure from content within a given File.
file
- File containing JSON contentcharset
- the charset for this FileParse a JSON data structure from content at a given URL.
url
- URL containing JSON contentParse a JSON data structure from content at a given URL.
url
- URL containing JSON contentparams
- connection parametersParse a JSON data structure from content at a given URL. Convenience variant when using Groovy named parameters for the connection params.
params
- connection parametersurl
- URL containing JSON contentParse a JSON data structure from content at a given URL.
url
- URL containing JSON contentcharset
- the charset for this FileParse a JSON data structure from content at a given URL.
url
- URL containing JSON contentparams
- connection parameterscharset
- the charset for this FileParse a JSON data structure from content at a given URL. Convenience variant when using Groovy named parameters for the connection params.
params
- connection parametersurl
- URL containing JSON contentcharset
- the charset for this FileParse a text representation of a JSON data structure
text
- JSON text to parseDetermine if slurper will automatically parse strings it recognizes as dates. Index overlay only.
Turns on buffer chopping for index overlay.
Turns on buffer lazy chopping for index overlay.
Max size before Slurper starts to use windowing buffer parser.
Parser type.