public class YamlBuilder extends GroovyObjectSupport implements Writable
A builder for creating YAML payloads.
| Constructor and description | 
|---|
| YamlBuilder
                                () | 
| Type Params | Return Type | Name and description | 
|---|---|---|
|  | public Object | call(Map m)Named arguments can be passed to the YAML builder instance to create a root YAML object | 
|  | public Object | call(List l)A list of elements as arguments to the YAML builder creates a root YAML array | 
|  | public Object | call(Object args)Varargs elements as arguments to the YAML builder create a root YAML array | 
|  | public Object | call(Iterable coll, Closure c)A collection and closure passed to a YAML builder will create a root YAML array applying the closure to each object in the collection | 
|  | public Object | call(Collection coll, Closure c)Delegates to call(Iterable, Closure) | 
|  | public Object | call(Closure c)A closure passed to a YAML builder will create a root YAML object | 
|  | public Object | getContent() | 
|  | public Object | invokeMethod(String name, Object args)A method call on the YAML builder instance will create a root object with only one key whose name is the name of the method being called. | 
|  | public String | toString()Serializes the internal data structure built with the builder to a conformant YAML payload string | 
|  | public Writer | writeTo(Writer out)The YAML builder implements the Writableinterface,
 so that you can have the builder serialize itself the YAML payload to a writer. | 
| Methods inherited from class | Name | 
|---|---|
| class GroovyObjectSupport | getMetaClass, setMetaClass | 
Named arguments can be passed to the YAML builder instance to create a root YAML object
Example:
 def yaml = new groovy.yaml.YamlBuilder()
 yaml name: "Guillaume", age: 33
 assert yaml.toString() == '''---
 name: "Guillaume"
 age: 33
 '''
 m -  a map of key / value pairsA list of elements as arguments to the YAML builder creates a root YAML array
Example:
 def yaml = new groovy.yaml.YamlBuilder()
 def result = yaml([1, 2, 3])
 assert result instanceof List
 assert yaml.toString() == '''---
 - 1
 - 2
 - 3
 '''
 l -  a list of valuesVarargs elements as arguments to the YAML builder create a root YAML array
Example:
 def yaml = new groovy.yaml.YamlBuilder()
 def result = yaml 1, 2, 3
 assert result instanceof List
 assert yaml.toString() == '''---
 - 1
 - 2
 - 3
 '''
 args -  an array of valuesA collection and closure passed to a YAML builder will create a root YAML 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")]
 def yaml = new groovy.yaml.YamlBuilder()
 yaml authors, { Author author ->
      name author.name
 }
 assert yaml.toString() == '''---
 - name: "Guillaume"
 - name: "Jochen"
 - name: "Paul"
 '''
 coll -  a collectionc -  a closure used to convert the objects of collDelegates to call(Iterable, Closure)
A closure passed to a YAML builder will create a root YAML object
Example:
 def yaml = new groovy.yaml.YamlBuilder()
 def result = yaml {
      name "Guillaume"
      age 33
 }
 assert result instanceof Map
 assert yaml.toString() == '''---
 name: "Guillaume"
 age: 33
 '''
 c -  a closure whose method call statements represent key / values of a YAML objectA method call on the YAML 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 classical builder-style:
 def yaml = new groovy.yaml.YamlBuilder()
 def result = yaml.person {
      name "Guillaume"
      age 33
 }
 assert result instanceof Map
 assert yaml.toString() == '''---
 person:
   name: "Guillaume"
   age: 33
 '''
 
 def yaml = new groovy.yaml.YamlBuilder()
 yaml.person name: "Guillaume", age: 33
 assert yaml.toString() == '''---
 person:
   name: "Guillaume"
   age: 33
 '''
 
 def yaml = new groovy.yaml.YamlBuilder()
 yaml.person(name: "Guillaume", age: 33) { town "Paris" }
 assert yaml.toString() == '''---
 person:
   name: "Guillaume"
   age: 33
   town: "Paris"
 '''
 
 def yaml = new groovy.yaml.YamlBuilder()
 yaml.person()
 assert yaml.toString() == '''---
 person: {}
 '''
 name -  the single keyargs -  the value associated with the keySerializes the internal data structure built with the builder to a conformant YAML payload string
Example:
 def yaml = new groovy.yaml.YamlBuilder()
 yaml { temperature 37 }
 assert yaml.toString() == '''---
 temperature: 37
 '''
  The YAML builder implements the Writable interface,
 so that you can have the builder serialize itself the YAML payload to a writer.
 
Example:
 def yaml = new groovy.yaml.YamlBuilder()
 yaml { temperature 37 }
 def out = new StringWriter()
 out << yaml
 assert out.toString() == '''---
 temperature: 37
 '''
 out -  a writer on which to serialize the YAML payloadCopyright © 2003-2024 The Apache Software Foundation. All rights reserved.