A builder for creating JSON payloads.
This builder supports the usual builder syntax made of nested method calls and closures, but also some specific aspects of JSON data structures, such as list of values, etc. Please make sure to have a look at the various methods provided by this builder to be able to learn about the various possibilities of usage.
Unlike the JsonBuilder class which creates a data structure in memory, which is handy in those situations where you want to alter the structure programatically before output, the StreamingJsonBuilder streams to a writer directly without any memory data structure. So if you don't need to modify the structure, and want a more memory-efficient approach, please use the StreamingJsonBuilder.
Example:
new StringWriter().with { w ->
def builder = new groovy.json.StreamingJsonBuilder( w )
builder.people {
person {
firstName 'Tim'
lastName 'Yates'
// Named arguments are valid values for objects too
address(
city: 'Manchester',
country: 'UK',
zip: 'M1 2AB',
)
living true
eyes 'left', 'right'
}
}
assert w.toString() == '{"people":{"person":{"firstName":"Tim","lastName":"Yates","address":{"city":"Manchester","country":"UK","zip":"M1 2AB"},"living":true,"eyes":["left","right"]}}}'
}
| Constructor and description |
|---|
StreamingJsonBuilder
(Writer writer)Instantiates a JSON builder. |
StreamingJsonBuilder
(Writer writer, Object content)Instantiates a JSON builder, possibly with some existing data structure. |
| Type | Name and description |
|---|---|
Object |
call(Map m)Named arguments can be passed to the JSON builder instance to create a root JSON object |
Object |
call(List l)A list of elements as arguments to the JSON builder creates a root JSON array |
Object |
call(Object... args)Varargs elements as arguments to the JSON builder create a root JSON array |
Object |
call(Collection coll, Closure c)A collection and closure passed to a JSON builder will create a root JSON array applying the closure to each object in the collection |
Object |
call(Closure c)A closure passed to a JSON builder will create a root JSON object |
Object |
invokeMethod(String name, Object args)A method call on the JSON builder instance will create a root object with only one key whose name is the name of the method being called. |
| Methods inherited from class | Name |
|---|---|
class GroovyObjectSupport |
getMetaClass, getProperty, invokeMethod, setMetaClass, setProperty |
class Object |
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll |
Instantiates a JSON builder.
writer - A writer to which Json will be writtenNamed arguments can be passed to the JSON builder instance to create a root JSON object
Example:
new StringWriter().with { w ->
def json = new groovy.json.StreamingJsonBuilder( w )
json name: "Tim", age: 31
assert w.toString() == '{"name":"Tim","age":31}'
}
m - a map of key / value pairsA list of elements as arguments to the JSON builder creates a root JSON array
Example:
new StringWriter().with { w ->
def json = new groovy.json.StreamingJsonBuilder( w )
def result = json([1, 2, 3])
assert result == [ 1, 2, 3 ]
assert w.toString() == "[1,2,3]"
}
l - a list of valuesVarargs elements as arguments to the JSON builder create a root JSON array
Example:
new StringWriter().with { w ->
def json = new groovy.json.StreamingJsonBuilder( w )
def result = json 1, 2, 3
assert result instanceof List
assert w.toString() == "[1,2,3]"
}
args - an array of valuesA collection and closure passed to a JSON builder will create a root JSON array applying the closure to each object in the collection
Example:
class Author {
String name
}
def authors = [new Author (name: "Guillaume"), new Author (name: "Jochen"), new Author (name: "Paul")]
new StringWriter().with { w ->
def json = new groovy.json.StreamingJsonBuilder( w )
json authors, { Author author ->
name author.name
}
assert w.toString() == '[{"name":"Guillaume"},{"name":"Jochen"},{"name":"Paul"}]'
}
coll - a collectionc - a closure used to convert the objects of collA closure passed to a JSON builder will create a root JSON object
Example:
new StringWriter().with { w ->
def json = new groovy.json.StreamingJsonBuilder( w )
json {
name "Tim"
age 39
}
assert w.toString() == '{"name":"Tim","age":39}'
}
c - a closure whose method call statements represent key / values of a JSON objectA method call on the JSON builder instance will create a root object with only one key whose name is the name of the method being called. This method takes as arguments:
Example with a classicala builder-style:
new StringWriter().with { w ->
def json = new groovy.json.StreamingJsonBuilder( w )
json.person {
name "Tim"
age 28
}
assert w.toString() == '{"person":{"name":"Tim","age":28}}'
}
Or alternatively with a method call taking named arguments:
new StringWriter().with { w ->
def json = new groovy.json.StreamingJsonBuilder( w )
json.person name: "Tim", age: 32
assert w.toString() == '{"person":{"name":"Tim","age":32}}'
}
If you use named arguments and a closure as last argument,
the key/value pairs of the map (as named arguments)
and the key/value pairs represented in the closure
will be merged together —
the closure properties overriding the map key/values
in case the same key is used.
new StringWriter().with { w ->
def json = new groovy.json.StreamingJsonBuilder( w )
json.person(name: "Tim", age: 35) { town "Manchester" }
assert w.toString() == '{"person":{"name":"Tim","age":35,"town":"Manchester"}}'
}
The empty args call will create a key whose value will be an empty JSON object:
new StringWriter().with { w ->
def json = new groovy.json.StreamingJsonBuilder( w )
json.person()
assert w.toString() == '{"person":{}}'
}
name - the single keyargs - the value associated with the keyCopyright © 2003-2014 The Codehaus. All rights reserved.