Package org.tomlj
Class Toml
java.lang.Object
org.tomlj.Toml
@DefaultQualifier(value=org.checkerframework.checker.nullness.qual.NonNull.class,
locations={RETURN,PARAMETER,FIELD})
public final class Toml
extends Object
Methods for parsing data stored in Tom's Obvious, Minimal Language (TOML).
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic String
canonicalDottedKey
(String dottedKey) Get the canonical form of the dotted key.static boolean
Performs a deep comparison between two arrays to determine if they are equivalent.static boolean
Performs a deep comparison between two tables to determine if they are equivalent.static String
joinKeyPath
(List<String> path) Join a list of keys into a single dotted key string.static TomlParseResult
parse
(InputStream is) Parse a TOML input stream.static TomlParseResult
parse
(InputStream is, TomlVersion version) Parse a TOML input stream.static TomlParseResult
Parse a TOML reader.static TomlParseResult
parse
(Reader reader, TomlVersion version) Parse a TOML input stream.static TomlParseResult
Parse a TOML string.static TomlParseResult
parse
(String input, TomlVersion version) Parse a TOML string.static TomlParseResult
parse
(ReadableByteChannel channel) Parse a TOML reader.static TomlParseResult
parse
(ReadableByteChannel channel, TomlVersion version) Parse a TOML input stream.static TomlParseResult
Parse a TOML file.static TomlParseResult
parse
(Path file, TomlVersion version) Parse a TOML file.parseDottedKey
(String dottedKey) Parse a dotted key into individual parts.static StringBuilder
tomlEscape
(String text) Escape a text string using the TOML escape sequences.
-
Field Details
-
simpleKeyPattern
-
-
Constructor Details
-
Toml
private Toml()
-
-
Method Details
-
parse
Parse a TOML string.- Parameters:
input
- The input to parse.- Returns:
- The parse result.
-
parse
Parse a TOML string.- Parameters:
input
- The input to parse.version
- The version level to parse at.- Returns:
- The parse result.
-
parse
Parse a TOML file.- Parameters:
file
- The input file to parse.- Returns:
- The parse result.
- Throws:
IOException
- If an IO error occurs.
-
parse
Parse a TOML file.- Parameters:
file
- The input file to parse.version
- The version level to parse at.- Returns:
- The parse result.
- Throws:
IOException
- If an IO error occurs.
-
parse
Parse a TOML input stream.- Parameters:
is
- The UTF-8 encoded input stream to read the TOML document from.- Returns:
- The parse result.
- Throws:
IOException
- If an IO error occurs.
-
parse
Parse a TOML input stream.- Parameters:
is
- The UTF-8 encoded input stream to read the TOML document from.version
- The version level to parse at.- Returns:
- The parse result.
- Throws:
IOException
- If an IO error occurs.
-
parse
Parse a TOML reader.- Parameters:
reader
- The reader to obtain the TOML document from.- Returns:
- The parse result.
- Throws:
IOException
- If an IO error occurs.
-
parse
Parse a TOML input stream.- Parameters:
reader
- The reader to obtain the TOML document from.version
- The version level to parse at.- Returns:
- The parse result.
- Throws:
IOException
- If an IO error occurs.
-
parse
Parse a TOML reader.- Parameters:
channel
- The channel to read the TOML document from.- Returns:
- The parse result.
- Throws:
IOException
- If an IO error occurs.
-
parse
public static TomlParseResult parse(ReadableByteChannel channel, TomlVersion version) throws IOException Parse a TOML input stream.- Parameters:
channel
- The UTF-8 encoded channel to read the TOML document from.version
- The version level to parse at.- Returns:
- The parse result.
- Throws:
IOException
- If an IO error occurs.
-
parseDottedKey
Parse a dotted key into individual parts.- Parameters:
dottedKey
- A dotted key (e.g.server.address.port
).- Returns:
- A list of individual keys in the path.
- Throws:
IllegalArgumentException
- If the dotted key cannot be parsed.
-
joinKeyPath
Join a list of keys into a single dotted key string.- Parameters:
path
- The list of keys that form the path.- Returns:
- The path string.
-
canonicalDottedKey
Get the canonical form of the dotted key.- Parameters:
dottedKey
- A dotted key (e.g.server.address.port
).- Returns:
- The canonical form of the dotted key.
- Throws:
IllegalArgumentException
- If the dotted key cannot be parsed.
-
tomlEscape
Escape a text string using the TOML escape sequences.- Parameters:
text
- The text string to escape.- Returns:
- A
StringBuilder
holding the results of escaping the text.
-
equals
Performs a deep comparison between two arrays to determine if they are equivalent.- Parameters:
array1
- First arrayarray2
- Second array- Returns:
- Returns true if the arrays are equivalent, else false.
-
equals
Performs a deep comparison between two tables to determine if they are equivalent.- Parameters:
table1
- First tabletable2
- Second table- Returns:
- Returns true if the tables are equivalent, else false.
-