TomlSlurper (Groovy 6.0.0-RC-2)

groovy.toml.TomlSlurper

@Incubating
public class TomlSlurper
extends Object

Represents a TOML parser

Since:: 4.0.0

Constructor Summary

Constructors
Constructor and description
`TomlSlurper()` Creates a TOML parser that produces standard Groovy data structures.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public JsonDateHandling`	`getDateHandling()` Returns how a date-like string is handled when parsing.
	`public Object`	`parse(Reader reader)` Parse the content of the specified reader into a tree of Nodes.
	`public Object`	`parse(InputStream stream)` Parse the content of the specified reader into a tree of Nodes.
	`public Object`	`parse(File file)` Parse the content of the specified file into a tree of Nodes.
	`public Object`	`parse(Path path)` Parse the content of the specified path into a tree of Nodes.
`<T>`	`public T`	`parseAs(Class<T> type, Reader reader)` Parse TOML from a reader into a typed object.
`<T>`	`public T`	`parseAs(Class<T> type, InputStream stream)` Parse TOML from an input stream into a typed object.
`<T>`	`public T`	`parseAs(Class<T> type, File file)` Parse TOML from a file into a typed object.
`<T>`	`public T`	`parseAs(Class<T> type, Path path)` Parse TOML from a path into a typed object.
	`public Object`	`parseText(String toml)` Parse the content of the specified toml into a tree of Nodes.
`<T>`	`public T`	`parseTextAs(Class<T> type, String toml)` Parse the content of the specified TOML text into a typed object using Jackson databinding.
	`public TomlSlurper`	`setDateHandling(JsonDateHandling dateHandling)` Chooses what a string in full ISO-8601 or JSON-date form becomes, matching the date handling JsonSlurper offers.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- Constructor Detail
  - public TomlSlurper()
    
    Creates a TOML parser that produces standard Groovy data structures.
- Method Detail
  - public JsonDateHandling getDateHandling()
    
    Returns how a date-like string is handled when parsing.
    Returns:
    the current date handling, JsonDateHandling.STRING by default
    See Also:
    setDateHandling(JsonDateHandling)
    Since:
    6.0.0
  - public Object parse(Reader reader)
    
    Parse the content of the specified reader into a tree of Nodes.
    Parameters:
    reader - the reader of toml
    Returns:
    the root node of the parsed tree of Nodes
  - public Object parse(InputStream stream)
    
    Parse the content of the specified reader into a tree of Nodes.
    Parameters:
    stream - the reader of toml
    Returns:
    the root node of the parsed tree of Nodes
  - public Object parse(File file)
    
    Parse the content of the specified file into a tree of Nodes.
    Parameters:
    file - the reader of toml
    Returns:
    the root node of the parsed tree of Nodes
  - public Object parse(Path path)
    
    Parse the content of the specified path into a tree of Nodes.
    Parameters:
    path - the reader of toml
    Returns:
    the root node of the parsed tree of Nodes
  - <T> public T parseAs(Class<T> type, Reader reader)
    
    Parse TOML from a reader into a typed object.
    Parameters:
    type - the target type
    reader - the reader of TOML
    Type Parameters:
    T - the target type
    Returns:
    a typed object
    Since:
    6.0.0
  - <T> public T parseAs(Class<T> type, InputStream stream)
    
    Parse TOML from an input stream into a typed object.
    Parameters:
    type - the target type
    stream - the input stream of TOML
    Type Parameters:
    T - the target type
    Returns:
    a typed object
    Since:
    6.0.0
  - <T> public T parseAs(Class<T> type, File file)
    
    Parse TOML from a file into a typed object.
    Parameters:
    type - the target type
    file - the TOML file
    Type Parameters:
    T - the target type
    Returns:
    a typed object
    Since:
    6.0.0
  - <T> public T parseAs(Class<T> type, Path path)
    
    Parse TOML from a path into a typed object.
    Parameters:
    type - the target type
    path - the path to the TOML file
    Type Parameters:
    T - the target type
    Returns:
    a typed object
    Since:
    6.0.0
  - public Object parseText(String toml)
    
    Parse the content of the specified toml into a tree of Nodes.
    Parameters:
    toml - the content of toml
    Returns:
    the root node of the parsed tree of Nodes
  - <T> public T parseTextAs(Class<T> type, String toml)
    
    Parse the content of the specified TOML text into a typed object using Jackson databinding. Supports @JsonProperty and @JsonFormat annotations for property mapping and type conversion.
    Parameters:
    type - the target type
    toml - the content of TOML
    Type Parameters:
    T - the target type
    Returns:
    a typed object
    Since:
    6.0.0
  - public TomlSlurper setDateHandling(JsonDateHandling dateHandling)
    
    Chooses what a string in full ISO-8601 or JSON-date form becomes, matching the date handling JsonSlurper offers. The default is JsonDateHandling.STRING: a date-like string is left as a String, which is what this slurper has always produced. A date carrying no time, such as "2026-09-04", is left as a String whatever is chosen here.
    Choosing anything other than JsonDateHandling.STRING switches the underlying parser to JsonParserType.INDEX_OVERLAY so the conversion takes effect; as a consequence, the iteration order of a map with more than a handful of entries is no longer the document order. Pass null or JsonDateHandling.STRING to restore the default parser and string handling.
    Parameters:
    dateHandling - what a date-like string should become
    Returns:
    this slurper, for chaining
    Since:
    6.0.0

Summary:
Constructor
Method

| Detail:
Constructor
Method

[Java] Class TomlSlurper

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

public TomlSlurper()

Method Detail

public JsonDateHandling getDateHandling()

public Object parse(Reader reader)

public Object parse(InputStream stream)

public Object parse(File file)

public Object parse(Path path)

<T> public T parseAs(Class<T> type, Reader reader)

<T> public T parseAs(Class<T> type, InputStream stream)

<T> public T parseAs(Class<T> type, File file)

<T> public T parseAs(Class<T> type, Path path)

public Object parseText(String toml)

<T> public T parseTextAs(Class<T> type, String toml)

public TomlSlurper setDateHandling(JsonDateHandling dateHandling)