Interface ConfigFormat

All Known Implementing Classes:

Json5Format, TomlFormat

public interface ConfigFormat

A config file's syntax. Values reach a format already encoded as JSON trees by their codecs, and are read back as JSON trees, so a format only translates syntax. ConfigFormats has the built-in ones.

Method Summary

Modifier and Type	Method	Description
String	extension()	The file extension, without the dot.
com.google.gson.JsonObject	read(String text)	Parses a file's text into nested objects.
String	write(ConfigDocument.Section document)	Writes a document, with its comments.

Method Details

extension

String extension()

The file extension, without the dot.

read

com.google.gson.JsonObject read(String text)
                         throws ConfigFormatException

Parses a file's text into nested objects.

Throws:

ConfigFormatException - when the text isn't valid in this format

write

String write(ConfigDocument.Section document)

Writes a document, with its comments.