# TOML format

TOML is a configuration file format that is intended to be easy to read and write due to obvious semantics which aim to be "minimal", and is designed to map unambiguously to a dictionary. Its specification is open-source, and receives community contributions. TOML is used in a number of software projects, and is implemented in a large number of programming languages.

# Dependencies

DataTree API supports 3 TOML implementations. For example, to use Toml4j's version, just add Toml4j JARs to the classpath. If DataTree detects Toml4j API on classpath, DataTree will use Toml4j API to read/write TOML documents.

<!-- DATATREE API -->
<dependency>
    <groupId>com.github.berkesa</groupId>
    <artifactId>datatree-adapters</artifactId>
    <version>1.0.15</version>
</dependency>

<!-- TOML4J API -->
<dependency>
    <groupId>com.moandjiezana.toml</groupId>
    <artifactId>toml4j</artifactId>
    <version>0.7.2</version>
</dependency>

# Reading and writing TOML documents

// Parsing TOML document
String toml = " ... TOML document ... ";
Tree document = new Tree(toml, "toml");

// Getting / setting values
document.get("subObject").forEach((child) -> {
  ...
});
document.putList("newList").add(1).add(2).add(3);

// Generating TOML string from Tree
String toml = document.toString("toml");

If there is more than one TOML implementation on classpath, the preferred implementation is adjustable with the following System Properties:

// Using JToml API:
-Ddatatree.toml.reader=io.datatree.dom.adapters.TomlJtoml
-Ddatatree.toml.writer=io.datatree.dom.adapters.TomlJtoml

// Using JToml2 API:
-Ddatatree.toml.reader=io.datatree.dom.adapters.TomlJtoml2
-Ddatatree.toml.writer=io.datatree.dom.adapters.TomlJtoml2

// Using Toml4j API:
-Ddatatree.toml.reader=io.datatree.dom.adapters.TomlToml4j
-Ddatatree.toml.writer=io.datatree.dom.adapters.TomlToml4j

# Required dependencies of TOML adapters