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