Field Detail

• private static final java.lang.String COLON_WITH_OPEN_BRACE

• private static final java.lang.String DOUBLE_CLOSE_BRACKET

• private final JsonGenerator generator

• private final java.io.Writer writer

Constructor Detail

• public StreamingJsonBuilder(java.io.Writer writer)

  Instantiates a JSON builder.

  Parameters:

  writer - A writer to which Json will be written

• public StreamingJsonBuilder(java.io.Writer writer, JsonGenerator generator)

  Instantiates a JSON builder with the given generator.

  Parameters:

  writer - A writer to which Json will be written

  generator - used to generate the output

  Since:

  2.5

• public StreamingJsonBuilder(java.io.Writer writer, java.lang.Object content)

  Instantiates a JSON builder, possibly with some existing data structure.

  throws:

  IOException If an I/O error occurs

  Parameters:

  writer - A writer to which Json will be written

  content - a pre-existing data structure, default to null

• public StreamingJsonBuilder(java.io.Writer writer, java.lang.Object content, JsonGenerator generator)

  Instantiates a JSON builder, possibly with some existing data structure and the given generator.

  throws:

  IOException If an I/O error occurs

  Parameters:

  writer - A writer to which Json will be written

  content - a pre-existing data structure, default to null

  generator - used to generate the output

  Since:

  2.5

Method Detail

• public java.lang.Object call(java.util.Map m)

  Named 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}'
   }
   

  throws:

  IOException If an I/O error occurs

  Parameters:

  m - a map of key / value pairs

  Returns:

  a map of key / value pairs

• public java.lang.Object call(groovy.lang.Writable writable)

  Invokes the given writable against the writer

  throws:

  IOException If an I/O error occurs

  Parameters:

  writable - a map of key / value pairs

  Returns:

  a map of key / value pairs

• public void call(java.lang.String name)

  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":{}}'
   }
   

  throws:

  IOException If an I/O error occurs

  Parameters:

  name - The name of the empty object to create

• public java.lang.Object call(java.util.List l)

  A 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]"
   }
   

  throws:

  IOException If an I/O error occurs

  Parameters:

  l - a list of values

  Returns:

  a list of values

• public java.lang.Object call(java.lang.Object args)

  Varargs 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]"
   }
   

  throws:

  IOException If an I/O error occurs

  Parameters:

  args - an array of values

  Returns:

  a list of values

• public java.lang.Object call(java.lang.Iterable coll, @groovy.lang.DelegatesTo(value = StreamingJsonDelegate.class, strategy = Closure.DELEGATE_FIRST) groovy.lang.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

  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"}]'
   }
   

  throws:

  IOException If an I/O error occurs

  Parameters:

  coll - a collection

  c - a closure used to convert the objects of coll

  Returns:

  a list of values

• public java.lang.Object call(@groovy.lang.DelegatesTo(value = StreamingJsonDelegate.class, strategy = Closure.DELEGATE_FIRST) groovy.lang.Closure c)

  A 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}'
   }
   

  throws:

  IOException If an I/O error occurs

  Parameters:

  c - a closure whose method call statements represent key / values of a JSON object

  Returns:

  a map of key / value pairs

• public void call(java.lang.String name, @groovy.lang.DelegatesTo(value = StreamingJsonDelegate.class, strategy = Closure.DELEGATE_FIRST) groovy.lang.Closure c)

  A name and a closure passed to a JSON builder will create a key with a JSON object

  Example:

   new StringWriter().with { w ->
     def json = new groovy.json.StreamingJsonBuilder(w)
     json.person {
        name "Tim"
        age 39
     }
  
     assert w.toString() == '{"person":{"name":"Tim","age":39}}'
   }
   

  throws:

  IOException If an I/O error occurs

  Parameters:

  name - The key for the JSON object

  c - a closure whose method call statements represent key / values of a JSON object

• public void call(java.lang.String name, java.lang.Iterable coll, @groovy.lang.DelegatesTo(value = StreamingJsonDelegate.class, strategy = Closure.DELEGATE_FIRST) groovy.lang.Closure c)

  A name, a 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.people authors, { Author author ->
           name author.name
       }
  
       assert w.toString() == '{"people":[{"name":"Guillaume"},{"name":"Jochen"},{"name":"Paul"}]}'
   }
   

  throws:

  IOException If an I/O error occurs

  Parameters:

  name - The name of the JSON attribute

  coll - a collection

  c - a closure used to convert the objects of coll

• public void call(java.lang.String name, java.util.Map map, @groovy.lang.DelegatesTo(value = StreamingJsonDelegate.class, strategy = Closure.DELEGATE_FIRST) groovy.lang.Closure callable)

  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"}}'
   }
   

  throws:

  IOException If an I/O error occurs

  Parameters:

  name - The name of the JSON object

  map - The attributes of the JSON object

  callable - Additional attributes of the JSON object represented by the closure

• public java.lang.Object invokeMethod(java.lang.String name, java.lang.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. This method takes as arguments:

  • a closure
  • a map (ie. named arguments)
  • a map and a closure
  • or no argument at all

  Example with a classical 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":{}}'
   }
   

  Parameters:

  name - the single key

  args - the value associated with the key