Property Detail

• HalViewHelper hal

  The HAL view helper

• StreamingJsonBuilder json

  The StreamingJsonBuilder instance

• JsonApiViewHelper jsonapi

  The JSON API view helper

• java.util.Map parentModel

  The parent model, if any

• GrailsViewTemplate parentTemplate

  The parent template if any

• TemplateRenderer tmpl

  The template namespace

Method Detail

• @java.lang.Override GrailsJsonViewHelper getG()

  Returns:

  The default view helper

• void inherits(java.util.Map arguments)

  Specify a template that this template inherits from

  Parameters:

  arguments - The arguments

• java.lang.Object json(java.util.Map m)

  Output JSON for the given map

  Parameters:

  m - The JSON map

  Returns:

  @throws IOException

• void json(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

  Parameters:

  name - The name of the empty object to create

• java.lang.Object json(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]"
   }
   

  Parameters:

  l - a list of values

  Returns:

  a list of values

• java.lang.Object json(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]"
   }
   

  Parameters:

  args - an array of values

  Returns:

  a list of values

• java.lang.Object json(java.lang.Iterable coll, @groovy.lang.DelegatesTo(StreamingJsonBuilder.StreamingJsonDelegate.class) 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"}]'
   }
   

  Parameters:

  coll - a collection

  c - a closure used to convert the objects of coll

• java.lang.Object json(@groovy.lang.DelegatesTo(StreamingJsonBuilder.StreamingJsonDelegate.class) 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}'
   }
   

  Parameters:

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

• void json(java.lang.String name, @groovy.lang.DelegatesTo(StreamingJsonBuilder.StreamingJsonDelegate.class) 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}}'
   }
   

  Parameters:

  name - The key for the JSON object

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

• void json(java.lang.String name, java.lang.Iterable coll, @groovy.lang.DelegatesTo(StreamingJsonBuilder.StreamingJsonDelegate.class) 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"}]}'
   }
   

  Parameters:

  coll - a collection

  c - a closure used to convert the objects of coll

• void json(java.lang.String name, java.util.Map map, @groovy.lang.DelegatesTo(StreamingJsonBuilder.StreamingJsonDelegate.class) 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

  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