Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- ABOVE - Enum constant in enum class org.tomlj.TomlComment.Placement
-
A run of comment lines written directly above the entry it is attached to.
- add(Object) - Method in interface org.tomlj.MutableTomlArray
-
Append a value to this array.
- addComment(String...) - Method in interface org.tomlj.MutableTomlArray
-
Add an unattached comment, after the elements already written, as
MutableTomlArray.addComment(List)does. - addComment(String...) - Method in interface org.tomlj.MutableTomlTable
-
Add an unattached comment, after the elements already written, as
MutableTomlTable.addComment(List)does. - addComment(List<String>) - Method in interface org.tomlj.MutableTomlArray
-
Add an unattached comment, after the elements already written.
- addComment(List<String>) - Method in interface org.tomlj.MutableTomlTable
-
Add an unattached comment, after the elements already written.
- addComment(TomlComment) - Method in interface org.tomlj.MutableTomlArray
-
Add a comment, after the elements already written.
- addComment(TomlComment) - Method in interface org.tomlj.MutableTomlTable
-
Add a comment, after the elements already written.
- AFTER - Enum constant in enum class org.tomlj.TomlComment.Placement
-
The comment written on the same line as the entry, after it.
- ALL_VALUES_AS_STRINGS - Enum constant in enum class org.tomlj.JsonOptions
-
Output all values as strings, rather than using integer, float or boolean values.
- as(Class<T>) - Method in interface org.tomlj.TomlArray
-
Bind this array to a Java type, with the default options.
- as(Class<T>) - Method in interface org.tomlj.TomlTable
-
Bind this table to a Java type, with the default options.
- as(Class<T>, TomlBindOptions) - Method in interface org.tomlj.TomlArray
-
Bind this array to a Java type.
- as(Class<T>, TomlBindOptions) - Method in interface org.tomlj.TomlTable
-
Bind this table to a Java type.
- as(GenericType<T>) - Method in interface org.tomlj.TomlArray
-
Bind this array to a generic Java type, with the default options.
- as(GenericType<T>) - Method in interface org.tomlj.TomlTable
-
Bind this table to a generic Java type, with the default options.
- as(GenericType<T>, TomlBindOptions) - Method in interface org.tomlj.TomlArray
-
Bind this array to a generic Java type.
- as(GenericType<T>, TomlBindOptions) - Method in interface org.tomlj.TomlTable
-
Bind this table to a generic Java type.
B
- binary(long) - Static method in interface org.tomlj.TomlValue
-
An integer to be written in binary, as
0b1010; seeTomlValue.hex(long). - blankLineBetweenNestedHeaders() - Method in class org.tomlj.TomlWriteOptions
-
Whether a blank line separates a header from the header of a table within it that directly follows it.
C
- canonicalDottedKey(String) - Static method in class org.tomlj.Toml
-
Get the canonical form of the dotted key.
- cause() - Method in class org.tomlj.TomlBindError
-
The exception that caused this error.
- clear() - Method in interface org.tomlj.MutableTomlArray
-
Remove every entry from this array.
- clear() - Method in interface org.tomlj.MutableTomlTable
-
Remove every entry from this table.
- column() - Method in class org.tomlj.TomlPosition
-
The column number.
- comment(int, TomlComment.Placement) - Method in interface org.tomlj.TomlArray
-
Get the comment attached to a value at a placement.
- comment(String, TomlComment.Placement) - Method in interface org.tomlj.TomlTable
-
Get the comment attached to a key at a placement.
- comment(List<String>, TomlComment.Placement) - Method in interface org.tomlj.TomlTable
-
Get the comment attached to a key at a placement.
- comment(TomlComment.Placement) - Method in interface org.tomlj.TomlEntry
-
The comment attached to this entry at a placement.
- comments() - Method in interface org.tomlj.TomlEntry
-
The comments attached to this entry.
- comments(int) - Method in interface org.tomlj.TomlArray
-
Get the comments attached to a value.
- comments(String) - Method in interface org.tomlj.TomlTable
-
Get the comments attached to a key.
- comments(List<String>) - Method in interface org.tomlj.TomlTable
-
Get the comments attached to a key.
- contains(String) - Method in interface org.tomlj.TomlTable
-
Check if a key was set in the TOML document.
- contains(List<String>) - Method in interface org.tomlj.TomlTable
-
Check if a key was set in the TOML document.
- copyOf(Iterable<?>) - Static method in interface org.tomlj.MutableTomlArray
-
Create an array from an
Iterable. - copyOf(Map<String, ?>) - Static method in interface org.tomlj.MutableTomlTable
-
Create a table from a
Map. - copyOf(TomlArray) - Static method in interface org.tomlj.MutableTomlArray
-
Create a deep copy of an array.
- copyOf(TomlTable) - Static method in interface org.tomlj.MutableTomlTable
-
Create a deep copy of a table.
- create() - Static method in interface org.tomlj.MutableTomlArray
-
Create a new, empty array.
- create() - Static method in interface org.tomlj.MutableTomlTable
-
Create a new, empty table.
- createInline() - Static method in interface org.tomlj.MutableTomlArray
-
Create a new, empty array to be written between brackets.
- createInline() - Static method in interface org.tomlj.MutableTomlTable
-
Create a new, empty inline table.
D
- DEFAULT_MAX_LINE_WIDTH - Static variable in class org.tomlj.TomlWriteOptions
-
The default maximum line width: 80.
- DEFAULT_MAX_NESTING_DEPTH - Static variable in class org.tomlj.TomlParseOptions
-
The default maximum nesting depth: 128.
- defaults() - Static method in class org.tomlj.TomlBindOptions
-
The default bind options: keys are the names of fields and record components, unchanged, a key with no field or component is an error, and no converters are registered.
- defaults() - Static method in class org.tomlj.TomlParseOptions
-
The default parse options:
TomlVersion.LATEST, with a maximum nesting depth of 128, keeping the text of the document parsed so that it can be written back as it was read. - defaults() - Static method in class org.tomlj.TomlWriteOptions
-
The default options:
LAYOUT, no indentation, a maximum line width of 80, no line separator of their own, so that lines end with the platform's,System.lineSeparator(), and output written forTomlVersion.LATEST. - dottedEntrySet() - Method in interface org.tomlj.TomlTable
-
Get all the dotted entries of this table.
- dottedEntrySet(boolean) - Method in interface org.tomlj.TomlTable
-
Get all the dotted entries of this table.
- dottedKeySet() - Method in interface org.tomlj.TomlTable
-
Get all the dotted keys of this table.
- dottedKeySet(boolean) - Method in interface org.tomlj.TomlTable
-
Get all the dotted keys of this table.
E
- elements() - Method in interface org.tomlj.TomlArray
-
Get the elements written in this array, in document order.
- elements() - Method in interface org.tomlj.TomlTable
-
Get the elements written in this table, in document order.
- entriesAlignedWithHeaders() - Method in class org.tomlj.TomlWriteOptions
-
Whether the entries of a table are indented like its header.
- entry(int) - Method in interface org.tomlj.MutableTomlArray
- entry(int) - Method in interface org.tomlj.TomlArray
-
Get the entry at an index.
- entry(String) - Method in interface org.tomlj.MutableTomlTable
- entry(String) - Method in interface org.tomlj.TomlTable
-
Get the entry for a key.
- entry(List<String>) - Method in interface org.tomlj.MutableTomlTable
- entry(List<String>) - Method in interface org.tomlj.TomlTable
-
Get the entry for a key.
- entryPathSet() - Method in interface org.tomlj.TomlTable
-
Get all the entries in this table.
- entryPathSet(boolean) - Method in interface org.tomlj.TomlTable
-
Get all the entries in this table.
- entrySet() - Method in interface org.tomlj.TomlTable
-
Get the entries of this table.
- equals(Object) - Method in class org.tomlj.TomlBindError
- equals(Object) - Method in class org.tomlj.TomlBindOptions
- equals(Object) - Method in class org.tomlj.TomlParseOptions
- equals(Object) - Method in class org.tomlj.TomlPosition
- equals(Object) - Method in class org.tomlj.TomlWriteOptions
- equals(TomlArray, TomlArray) - Static method in class org.tomlj.Toml
-
Performs a deep comparison between two arrays to determine if they are equivalent.
- equals(TomlTable, TomlTable) - Static method in class org.tomlj.Toml
-
Performs a deep comparison between two tables to determine if they are equivalent.
- errors() - Method in exception class org.tomlj.TomlBindException
-
The errors found.
- errors() - Method in exception class org.tomlj.TomlParseException
-
The errors found.
- errors() - Method in interface org.tomlj.TomlParseResult
-
The errors that occurred during parsing.
- EXACT - Enum constant in enum class org.tomlj.TomlBindOptions.KeyNaming
-
The key is the name, unchanged:
maxConnectionsis bound tomaxConnections.
F
- from(Object) - Static method in interface org.tomlj.MutableTomlArray
-
Create an array holding the elements of a collection or Java array, with the default options.
- from(Object) - Static method in interface org.tomlj.MutableTomlTable
-
Create a table holding the members of a record or class, or the entries of a map, with the default options.
- from(Object, TomlBindOptions) - Static method in interface org.tomlj.MutableTomlArray
-
Create an array holding the elements of a collection or Java array.
- from(Object, TomlBindOptions) - Static method in interface org.tomlj.MutableTomlTable
-
Create a table holding the members of a record or class, or the entries of a map.
G
- GenericType<T> - Class in org.tomlj
-
A generic type to bind a table or array to, such as
Map<String, Server>orList<Server>. - GenericType() - Constructor for class org.tomlj.GenericType
-
Create a generic type that names the type argument given to
GenericTypeby the subclass, resolved through any class between it andGenericType. - get() - Method in interface org.tomlj.TomlValue
-
Get the value.
- get(int) - Method in interface org.tomlj.TomlArray
-
Get a value at a specified index.
- get(String) - Method in interface org.tomlj.TomlTable
-
Get a value from the TOML document.
- get(List<String>) - Method in interface org.tomlj.TomlTable
-
Get a value from the TOML document.
- getArray() - Method in interface org.tomlj.TomlValue
-
Get this value as an array.
- getArray(int) - Method in interface org.tomlj.MutableTomlArray
- getArray(int) - Method in interface org.tomlj.TomlArray
-
Get an array at a specified index.
- getArray(String) - Method in interface org.tomlj.MutableTomlTable
- getArray(String) - Method in interface org.tomlj.TomlTable
-
Get an array from the TOML document.
- getArray(List<String>) - Method in interface org.tomlj.MutableTomlTable
- getArray(List<String>) - Method in interface org.tomlj.TomlTable
-
Get an array from the TOML document.
- getArrayOrEmpty(String) - Method in interface org.tomlj.TomlTable
-
Get an array from the TOML document.
- getArrayOrEmpty(List<String>) - Method in interface org.tomlj.TomlTable
-
Get an array from the TOML document.
- getBoolean() - Method in interface org.tomlj.TomlValue
-
Get this value as a boolean.
- getBoolean(int) - Method in interface org.tomlj.TomlArray
-
Get a boolean at a specified index.
- getBoolean(String) - Method in interface org.tomlj.TomlTable
-
Get a boolean from the TOML document.
- getBoolean(String, BooleanSupplier) - Method in interface org.tomlj.TomlTable
-
Get a boolean from the TOML document, or return a default.
- getBoolean(List<String>) - Method in interface org.tomlj.TomlTable
-
Get a boolean from the TOML document.
- getBoolean(List<String>, BooleanSupplier) - Method in interface org.tomlj.TomlTable
-
Get a boolean from the TOML document, or return a default.
- getDouble() - Method in interface org.tomlj.TomlValue
-
Get this value as a double.
- getDouble(int) - Method in interface org.tomlj.TomlArray
-
Get a double at a specified index.
- getDouble(String) - Method in interface org.tomlj.TomlTable
-
Get a double from the TOML document.
- getDouble(String, DoubleSupplier) - Method in interface org.tomlj.TomlTable
-
Get a double from the TOML document, or return a default.
- getDouble(List<String>) - Method in interface org.tomlj.TomlTable
-
Get a double from the TOML document.
- getDouble(List<String>, DoubleSupplier) - Method in interface org.tomlj.TomlTable
-
Get a double from the TOML document, or return a default.
- getLocalDate() - Method in interface org.tomlj.TomlValue
-
Get this value as a local date.
- getLocalDate(int) - Method in interface org.tomlj.TomlArray
-
Get a local date at a specified index.
- getLocalDate(String) - Method in interface org.tomlj.TomlTable
-
Get a local date from the TOML document.
- getLocalDate(String, Supplier<LocalDate>) - Method in interface org.tomlj.TomlTable
-
Get a local date from the TOML document, or return a default.
- getLocalDate(List<String>) - Method in interface org.tomlj.TomlTable
-
Get a local date from the TOML document.
- getLocalDate(List<String>, Supplier<LocalDate>) - Method in interface org.tomlj.TomlTable
-
Get a local date from the TOML document, or return a default.
- getLocalDateTime() - Method in interface org.tomlj.TomlValue
-
Get this value as a local date-time.
- getLocalDateTime(int) - Method in interface org.tomlj.TomlArray
-
Get a local date time at a specified index.
- getLocalDateTime(String) - Method in interface org.tomlj.TomlTable
-
Get a local date time from the TOML document.
- getLocalDateTime(String, Supplier<LocalDateTime>) - Method in interface org.tomlj.TomlTable
-
Get a local date time from the TOML document, or return a default.
- getLocalDateTime(List<String>) - Method in interface org.tomlj.TomlTable
-
Get a local date time from the TOML document.
- getLocalDateTime(List<String>, Supplier<LocalDateTime>) - Method in interface org.tomlj.TomlTable
-
Get a local date time from the TOML document, or return a default.
- getLocalTime() - Method in interface org.tomlj.TomlValue
-
Get this value as a local time.
- getLocalTime(int) - Method in interface org.tomlj.TomlArray
-
Get a local time at a specified index.
- getLocalTime(String) - Method in interface org.tomlj.TomlTable
-
Get a local time from the TOML document.
- getLocalTime(String, Supplier<LocalTime>) - Method in interface org.tomlj.TomlTable
-
Get a local time from the TOML document, or return a default.
- getLocalTime(List<String>) - Method in interface org.tomlj.TomlTable
-
Get a local time from the TOML document.
- getLocalTime(List<String>, Supplier<LocalTime>) - Method in interface org.tomlj.TomlTable
-
Get a local time from the TOML document, or return a default.
- getLong() - Method in interface org.tomlj.TomlValue
-
Get this value as a long.
- getLong(int) - Method in interface org.tomlj.TomlArray
-
Get a long at a specified index.
- getLong(String) - Method in interface org.tomlj.TomlTable
-
Get a long from the TOML document.
- getLong(String, LongSupplier) - Method in interface org.tomlj.TomlTable
-
Get a long from the TOML document, or return a default.
- getLong(List<String>) - Method in interface org.tomlj.TomlTable
-
Get a long from the TOML document.
- getLong(List<String>, LongSupplier) - Method in interface org.tomlj.TomlTable
-
Get a long from the TOML document, or return a default.
- getOffsetDateTime() - Method in interface org.tomlj.TomlValue
-
Get this value as an offset date-time.
- getOffsetDateTime(int) - Method in interface org.tomlj.TomlArray
-
Get an offset date time at a specified index.
- getOffsetDateTime(String) - Method in interface org.tomlj.TomlTable
-
Get an offset date time from the TOML document.
- getOffsetDateTime(String, Supplier<OffsetDateTime>) - Method in interface org.tomlj.TomlTable
-
Get an offset date time from the TOML document, or return a default.
- getOffsetDateTime(List<String>) - Method in interface org.tomlj.TomlTable
-
Get an offset date time from the TOML document.
- getOffsetDateTime(List<String>, Supplier<OffsetDateTime>) - Method in interface org.tomlj.TomlTable
-
Get an offset date time from the TOML document, or return a default.
- getOrCreateArray(String) - Method in interface org.tomlj.MutableTomlTable
-
Get the array at a key, creating it, and any intermediate table that does not already exist, if necessary.
- getOrCreateArray(List<String>) - Method in interface org.tomlj.MutableTomlTable
-
Get the array at a path, creating it, and any intermediate table that does not already exist, if necessary.
- getOrCreateTable(String) - Method in interface org.tomlj.MutableTomlTable
-
Get the table at a key, creating it, and any intermediate table that does not already exist, if necessary.
- getOrCreateTable(List<String>) - Method in interface org.tomlj.MutableTomlTable
-
Get the table at a path, creating it, and any intermediate table that does not already exist, if necessary.
- getString() - Method in interface org.tomlj.TomlValue
-
Get this value as a string.
- getString(int) - Method in interface org.tomlj.TomlArray
-
Get a string at a specified index.
- getString(String) - Method in interface org.tomlj.TomlTable
-
Get a string from the TOML document.
- getString(String, Supplier<String>) - Method in interface org.tomlj.TomlTable
-
Get a string from the TOML document, or return a default.
- getString(List<String>) - Method in interface org.tomlj.TomlTable
-
Get a string from the TOML document.
- getString(List<String>, Supplier<String>) - Method in interface org.tomlj.TomlTable
-
Get a string from the TOML document, or return a default.
- getTable() - Method in interface org.tomlj.TomlValue
-
Get this value as a table.
- getTable(int) - Method in interface org.tomlj.MutableTomlArray
- getTable(int) - Method in interface org.tomlj.TomlArray
-
Get a table at a specified index.
- getTable(String) - Method in interface org.tomlj.MutableTomlTable
- getTable(String) - Method in interface org.tomlj.TomlTable
-
Get a table from the TOML document.
- getTable(List<String>) - Method in interface org.tomlj.MutableTomlTable
- getTable(List<String>) - Method in interface org.tomlj.TomlTable
-
Get a table from the TOML document.
- getTableOrEmpty(String) - Method in interface org.tomlj.TomlTable
-
Get a table from the TOML document.
- getTableOrEmpty(List<String>) - Method in interface org.tomlj.TomlTable
-
Get a table from the TOML document.
- grouped(long) - Static method in interface org.tomlj.TomlValue
-
An integer to be written in decimal with its digits grouped in threes, as
1_000_000; seeTomlValue.hex(long).
H
- hasErrors() - Method in interface org.tomlj.TomlParseResult
-
trueif the TOML document contained errors. - hashCode() - Method in class org.tomlj.TomlBindError
- hashCode() - Method in class org.tomlj.TomlBindOptions
- hashCode() - Method in class org.tomlj.TomlParseOptions
- hashCode() - Method in class org.tomlj.TomlPosition
- hashCode() - Method in class org.tomlj.TomlWriteOptions
- HEAD - Enum constant in enum class org.tomlj.TomlVersion
-
The head (development) specification of TOML.
- hex(long) - Static method in interface org.tomlj.TomlValue
-
An integer to be written in hexadecimal with uppercase digits, as
0xFF. - hexLowercase(long) - Static method in interface org.tomlj.TomlValue
-
An integer to be written in hexadecimal with lowercase digits, as
0xff; seeTomlValue.hex(long).
I
- ignoresUnknownKeys() - Method in class org.tomlj.TomlBindOptions
-
Whether a key with no field or record component is ignored.
- indent() - Method in class org.tomlj.TomlWriteOptions
-
The number of spaces to indent per level of table nesting.
- inNotationOf(TomlValue, long) - Static method in interface org.tomlj.TomlValue
-
An integer to be written in the notation another integer was written in, if that notation can hold it: hexadecimal with the same case of digits, octal, binary, or decimal with its digits grouped, which are grouped in threes.
- inNotationOf(TomlValue, String) - Static method in interface org.tomlj.TomlValue
-
A string to be written in the notation another string was written in, if that notation can hold it: a literal or multi-line literal string.
- inputPositionOf(int) - Method in interface org.tomlj.TomlArray
-
Get the position where a value is defined in the TOML document.
- inputPositionOf(String) - Method in interface org.tomlj.TomlTable
-
Get the position where a key is defined in the TOML document.
- inputPositionOf(List<String>) - Method in interface org.tomlj.TomlTable
-
Get the position where a key is defined in the TOML document.
- insertAfter(int, Object) - Method in interface org.tomlj.MutableTomlArray
-
Insert a value into this array immediately after the entry at an index.
- insertAfter(String, String, Object) - Method in interface org.tomlj.MutableTomlTable
-
Insert a value into this table after an existing entry, as
MutableTomlTable.insertAfter(List, String, Object)does. - insertAfter(List<String>, String, Object) - Method in interface org.tomlj.MutableTomlTable
-
Insert a value into this table after an existing entry.
- insertAfter(TomlElement, Object) - Method in interface org.tomlj.MutableTomlArray
-
Insert a value into this array immediately after an element of its sequence.
- insertAfter(TomlElement, String, Object) - Method in interface org.tomlj.MutableTomlTable
-
Insert a value into this table immediately after an element of its sequence.
- insertBefore(int, Object) - Method in interface org.tomlj.MutableTomlArray
-
Insert a value into this array immediately before the entry at an index.
- insertBefore(String, String, Object) - Method in interface org.tomlj.MutableTomlTable
-
Insert a value into this table before an existing entry, as
MutableTomlTable.insertBefore(List, String, Object)does. - insertBefore(List<String>, String, Object) - Method in interface org.tomlj.MutableTomlTable
-
Insert a value into this table before an existing entry.
- insertBefore(TomlElement, Object) - Method in interface org.tomlj.MutableTomlArray
-
Insert a value into this array immediately before an element of its sequence.
- insertBefore(TomlElement, String, Object) - Method in interface org.tomlj.MutableTomlTable
-
Insert a value into this table immediately before an element of its sequence.
- insertCommentAfter(int, String...) - Method in interface org.tomlj.MutableTomlArray
-
Insert an unattached comment into this array immediately after the entry at an index, as
MutableTomlArray.insertCommentAfter(int, List)does. - insertCommentAfter(int, List<String>) - Method in interface org.tomlj.MutableTomlArray
-
Insert an unattached comment into this array immediately after the entry at an index, as
MutableTomlArray.insertCommentAfter(int, TomlComment)places one. - insertCommentAfter(int, TomlComment) - Method in interface org.tomlj.MutableTomlArray
-
Insert a comment into this array immediately after the entry at an index.
- insertCommentAfter(String, String...) - Method in interface org.tomlj.MutableTomlTable
-
Insert an unattached comment into this table after an existing entry, as
MutableTomlTable.insertCommentAfter(List, List)does. - insertCommentAfter(String, List<String>) - Method in interface org.tomlj.MutableTomlTable
-
Insert an unattached comment into this table after an existing entry, as
MutableTomlTable.insertCommentAfter(List, List)does. - insertCommentAfter(String, TomlComment) - Method in interface org.tomlj.MutableTomlTable
-
Insert a comment into this table after an existing entry, as
MutableTomlTable.insertCommentAfter(List, TomlComment)does. - insertCommentAfter(List<String>, String...) - Method in interface org.tomlj.MutableTomlTable
-
Insert an unattached comment into this table after an existing entry, as
MutableTomlTable.insertCommentAfter(List, List)does. - insertCommentAfter(List<String>, List<String>) - Method in interface org.tomlj.MutableTomlTable
-
Insert an unattached comment into this table after an existing entry, as
MutableTomlTable.insertCommentAfter(List, TomlComment)places one. - insertCommentAfter(List<String>, TomlComment) - Method in interface org.tomlj.MutableTomlTable
-
Insert a comment into this table after an existing entry.
- insertCommentAfter(TomlElement, String...) - Method in interface org.tomlj.MutableTomlArray
-
Insert an unattached comment into this array immediately after an element of its sequence, as
MutableTomlArray.insertCommentAfter(TomlElement, List)does. - insertCommentAfter(TomlElement, String...) - Method in interface org.tomlj.MutableTomlTable
-
Insert an unattached comment into this table immediately after an element of its sequence, as
MutableTomlTable.insertCommentAfter(TomlElement, List)does. - insertCommentAfter(TomlElement, List<String>) - Method in interface org.tomlj.MutableTomlArray
-
Insert an unattached comment into this array immediately after an element of its sequence, as
MutableTomlArray.insertCommentAfter(TomlElement, TomlComment)places one. - insertCommentAfter(TomlElement, List<String>) - Method in interface org.tomlj.MutableTomlTable
-
Insert an unattached comment into this table immediately after an element of its sequence, as
MutableTomlTable.insertCommentAfter(TomlElement, TomlComment)places one. - insertCommentAfter(TomlElement, TomlComment) - Method in interface org.tomlj.MutableTomlArray
-
Insert a comment into this array immediately after an element of its sequence.
- insertCommentAfter(TomlElement, TomlComment) - Method in interface org.tomlj.MutableTomlTable
-
Insert a comment into this table immediately after an element of its sequence.
- insertCommentBefore(int, String...) - Method in interface org.tomlj.MutableTomlArray
-
Insert an unattached comment into this array immediately before the entry at an index, as
MutableTomlArray.insertCommentBefore(int, List)does. - insertCommentBefore(int, List<String>) - Method in interface org.tomlj.MutableTomlArray
-
Insert an unattached comment into this array immediately before the entry at an index, as
MutableTomlArray.insertCommentBefore(int, TomlComment)places one. - insertCommentBefore(int, TomlComment) - Method in interface org.tomlj.MutableTomlArray
-
Insert a comment into this array immediately before the entry at an index.
- insertCommentBefore(String, String...) - Method in interface org.tomlj.MutableTomlTable
-
Insert an unattached comment into this table before an existing entry, as
MutableTomlTable.insertCommentBefore(List, List)does. - insertCommentBefore(String, List<String>) - Method in interface org.tomlj.MutableTomlTable
-
Insert an unattached comment into this table before an existing entry, as
MutableTomlTable.insertCommentBefore(List, List)does. - insertCommentBefore(String, TomlComment) - Method in interface org.tomlj.MutableTomlTable
-
Insert a comment into this table before an existing entry, as
MutableTomlTable.insertCommentBefore(List, TomlComment)does. - insertCommentBefore(List<String>, String...) - Method in interface org.tomlj.MutableTomlTable
-
Insert an unattached comment into this table before an existing entry, as
MutableTomlTable.insertCommentBefore(List, List)does. - insertCommentBefore(List<String>, List<String>) - Method in interface org.tomlj.MutableTomlTable
-
Insert an unattached comment into this table before an existing entry, as
MutableTomlTable.insertCommentBefore(List, TomlComment)places one. - insertCommentBefore(List<String>, TomlComment) - Method in interface org.tomlj.MutableTomlTable
-
Insert a comment into this table before an existing entry.
- insertCommentBefore(TomlElement, String...) - Method in interface org.tomlj.MutableTomlArray
-
Insert an unattached comment into this array immediately before an element of its sequence, as
MutableTomlArray.insertCommentBefore(TomlElement, List)does. - insertCommentBefore(TomlElement, String...) - Method in interface org.tomlj.MutableTomlTable
-
Insert an unattached comment into this table immediately before an element of its sequence, as
MutableTomlTable.insertCommentBefore(TomlElement, List)does. - insertCommentBefore(TomlElement, List<String>) - Method in interface org.tomlj.MutableTomlArray
-
Insert an unattached comment into this array immediately before an element of its sequence, as
MutableTomlArray.insertCommentBefore(TomlElement, TomlComment)places one. - insertCommentBefore(TomlElement, List<String>) - Method in interface org.tomlj.MutableTomlTable
-
Insert an unattached comment into this table immediately before an element of its sequence, as
MutableTomlTable.insertCommentBefore(TomlElement, TomlComment)places one. - insertCommentBefore(TomlElement, TomlComment) - Method in interface org.tomlj.MutableTomlArray
-
Insert a comment into this array immediately before an element of its sequence.
- insertCommentBefore(TomlElement, TomlComment) - Method in interface org.tomlj.MutableTomlTable
-
Insert a comment into this table immediately before an element of its sequence.
- isArray() - Method in interface org.tomlj.TomlValue
-
trueif this value is an array. - isArray(int) - Method in interface org.tomlj.TomlArray
-
trueif the value at an index is an array. - isArray(String) - Method in interface org.tomlj.TomlTable
-
Check if a value in the TOML document is an array.
- isArray(List<String>) - Method in interface org.tomlj.TomlTable
-
Check if a value in the TOML document is an array.
- isBoolean() - Method in interface org.tomlj.TomlValue
-
trueif this value is a boolean. - isBoolean(int) - Method in interface org.tomlj.TomlArray
-
trueif the value at an index is a boolean. - isBoolean(String) - Method in interface org.tomlj.TomlTable
-
Check if a value in the TOML document is a boolean.
- isBoolean(List<String>) - Method in interface org.tomlj.TomlTable
-
Check if a value in the TOML document is a boolean.
- isDouble() - Method in interface org.tomlj.TomlValue
-
trueif this value is a double. - isDouble(int) - Method in interface org.tomlj.TomlArray
-
trueif the value at an index is a double. - isDouble(String) - Method in interface org.tomlj.TomlTable
-
Check if a value in the TOML document is a double.
- isDouble(List<String>) - Method in interface org.tomlj.TomlTable
-
Check if a value in the TOML document is a double.
- isEmpty() - Method in interface org.tomlj.TomlArray
-
trueif the array is empty. - isEmpty() - Method in interface org.tomlj.TomlTable
-
trueif there are no entries in this table. - isLocalDate() - Method in interface org.tomlj.TomlValue
-
trueif this value is a local date. - isLocalDate(int) - Method in interface org.tomlj.TomlArray
-
trueif the value at an index is a local date. - isLocalDate(String) - Method in interface org.tomlj.TomlTable
-
Check if a value in the TOML document is a
LocalDate. - isLocalDate(List<String>) - Method in interface org.tomlj.TomlTable
-
Check if a value in the TOML document is a
LocalDate. - isLocalDateTime() - Method in interface org.tomlj.TomlValue
-
trueif this value is a local date-time. - isLocalDateTime(int) - Method in interface org.tomlj.TomlArray
-
trueif the value at an index is a local date-time. - isLocalDateTime(String) - Method in interface org.tomlj.TomlTable
-
Check if a value in the TOML document is a
LocalDateTime. - isLocalDateTime(List<String>) - Method in interface org.tomlj.TomlTable
-
Check if a value in the TOML document is a
LocalDateTime. - isLocalTime() - Method in interface org.tomlj.TomlValue
-
trueif this value is a local time. - isLocalTime(int) - Method in interface org.tomlj.TomlArray
-
trueif the value at an index is a local time. - isLocalTime(String) - Method in interface org.tomlj.TomlTable
-
Check if a value in the TOML document is a
LocalTime. - isLocalTime(List<String>) - Method in interface org.tomlj.TomlTable
-
Check if a value in the TOML document is a
LocalTime. - isLong() - Method in interface org.tomlj.TomlValue
-
trueif this value is a long. - isLong(int) - Method in interface org.tomlj.TomlArray
-
trueif the value at an index is a long. - isLong(String) - Method in interface org.tomlj.TomlTable
-
Check if a value in the TOML document is a long.
- isLong(List<String>) - Method in interface org.tomlj.TomlTable
-
Check if a value in the TOML document is a long.
- isModified() - Method in interface org.tomlj.MutableTomlArray
-
Whether this array was changed through this interface.
- isModified() - Method in interface org.tomlj.MutableTomlEntry
-
Whether this entry was changed through the editing API.
- isModified() - Method in interface org.tomlj.MutableTomlTable
-
Whether this table was changed through this interface.
- isModified(int) - Method in interface org.tomlj.MutableTomlArray
-
Whether an entry of this array was changed through this interface.
- isModified(String) - Method in interface org.tomlj.MutableTomlTable
-
Whether an entry of this table was changed through this interface, as
MutableTomlTable.isModified(List)reports. - isModified(List<String>) - Method in interface org.tomlj.MutableTomlTable
-
Whether an entry of this table was changed through this interface.
- isOffsetDateTime() - Method in interface org.tomlj.TomlValue
-
trueif this value is an offset date-time. - isOffsetDateTime(int) - Method in interface org.tomlj.TomlArray
-
trueif the value at an index is an offset date-time. - isOffsetDateTime(String) - Method in interface org.tomlj.TomlTable
-
Check if a value in the TOML document is an
OffsetDateTime. - isOffsetDateTime(List<String>) - Method in interface org.tomlj.TomlTable
-
Check if a value in the TOML document is an
OffsetDateTime. - isString() - Method in interface org.tomlj.TomlValue
-
trueif this value is a string. - isString(int) - Method in interface org.tomlj.TomlArray
-
trueif the value at an index is a string. - isString(String) - Method in interface org.tomlj.TomlTable
-
Check if a value in the TOML document is a string.
- isString(List<String>) - Method in interface org.tomlj.TomlTable
-
Check if a value in the TOML document is a string.
- isTable() - Method in interface org.tomlj.TomlValue
-
trueif this value is a table. - isTable(int) - Method in interface org.tomlj.TomlArray
-
trueif the value at an index is a table. - isTable(String) - Method in interface org.tomlj.TomlTable
-
Check if a value in the TOML document is a table.
- isTable(List<String>) - Method in interface org.tomlj.TomlTable
-
Check if a value in the TOML document is a table.
J
- joinKeyPath(List<String>) - Static method in class org.tomlj.Toml
-
Join a list of keys into a single dotted key string.
- JsonOptions - Enum Class in org.tomlj
-
Options for serializing TOML to JSON.
K
- KEBAB_CASE - Enum constant in enum class org.tomlj.TomlBindOptions.KeyNaming
-
The words of the name, in lower case, joined by
-:maxConnectionsis bound tomax-connections, andhttpURLtohttp-url. - keep() - Method in class org.tomlj.TomlWriteOptions
-
How much of the existing document structure and format is kept.
- keep(TomlWriteOptions.Keep) - Method in class org.tomlj.TomlWriteOptions
-
Create a copy of these options that keeps a different amount of the existing document structure and format.
- key() - Method in interface org.tomlj.TomlKeyValue
-
The key of this pair.
- keyNaming() - Method in class org.tomlj.TomlBindOptions
-
How names of fields and record components are turned into keys.
- keyPathSet() - Method in interface org.tomlj.TomlTable
-
Get all the paths in this table.
- keyPathSet(boolean) - Method in interface org.tomlj.TomlTable
-
Get all the paths in this table.
- keySet() - Method in interface org.tomlj.TomlTable
-
Get the keys of this table.
L
- LATEST - Enum constant in enum class org.tomlj.TomlVersion
-
The latest stable specification of TOML.
- LAYOUT - Enum constant in enum class org.tomlj.TomlWriteOptions.Keep
-
Keep the layout of a parsed document: every line, header and comment the parser accepted is written back as it was read, with its spacing, indentation and blank lines, and only what the editing API changed is written anew.
- line() - Method in class org.tomlj.TomlPosition
-
The line number.
- lines() - Method in class org.tomlj.TomlComment
-
The text of each line, one entry per line of the run, in document order.
- lineSeparator() - Method in class org.tomlj.TomlWriteOptions
-
The line separator written at the end of each line.
- literal(String) - Static method in interface org.tomlj.TomlValue
-
A string to be written as a literal string, between apostrophes with nothing escaped, as
'C:\Users'; seeTomlValue.hex(long).
M
- main(String[]) - Static method in class org.tomlj.TomlCommand
-
The main method.
- maxLineWidth() - Method in class org.tomlj.TomlWriteOptions
-
The widest a line may be for an array to be written on one line.
- maxNestingDepth() - Method in class org.tomlj.TomlParseOptions
-
The maximum nesting depth allowed in a parsed document.
- message() - Method in class org.tomlj.TomlBindError
-
What is wrong with the value, such as
expected an integer, found a string. - multilineLiteral(String) - Static method in interface org.tomlj.TomlValue
-
A string to be written as a multi-line literal string, between triple apostrophes with nothing escaped, its newlines written as line breaks; see
TomlValue.hex(long). - MutableTomlArray - Interface in org.tomlj
-
A
TomlArraywhose values can be edited in place. - MutableTomlEntry - Interface in org.tomlj
-
A
TomlEntrywhose value and attached comments can be edited in place. - MutableTomlKeyValue - Interface in org.tomlj
-
A
TomlKeyValuewhose value and attached comments can be edited in place. - MutableTomlTable - Interface in org.tomlj
-
A
TomlTablewhose values can be edited in place.
N
- NOTATION - Enum constant in enum class org.tomlj.TomlWriteOptions.Keep
-
Keep the notation of a parsed document: the form each key, value and table was written in, whether
0x10or16, a bare or quoted key, a basic or literal string, a header, dotted keys or an inline table. - NOTHING - Enum constant in enum class org.tomlj.TomlWriteOptions.Keep
-
Keep nothing: everything is written in the default style.
O
- octal(long) - Static method in interface org.tomlj.TomlValue
-
An integer to be written in octal, as
0o755; seeTomlValue.hex(long). - of(Object...) - Static method in interface org.tomlj.MutableTomlArray
-
Create an array from a sequence of values.
- org.tomlj - package org.tomlj
-
A parser and writer for Tom's Obvious, Minimal Language (TOML).
P
- parse(InputStream) - Static method in class org.tomlj.Toml
-
Parse a TOML input stream.
- parse(InputStream, TomlParseOptions) - Static method in class org.tomlj.Toml
-
Parse a TOML input stream.
- parse(InputStream, TomlVersion) - Static method in class org.tomlj.Toml
-
Parse a TOML input stream.
- parse(Reader) - Static method in class org.tomlj.Toml
-
Parse a TOML reader.
- parse(Reader, TomlParseOptions) - Static method in class org.tomlj.Toml
-
Parse a TOML input stream.
- parse(Reader, TomlVersion) - Static method in class org.tomlj.Toml
-
Parse a TOML input stream.
- parse(String) - Static method in class org.tomlj.Toml
-
Parse a TOML string.
- parse(String) - Static method in interface org.tomlj.TomlValue
-
Parse the text of one value, written as it is after the
=of akey = valueline, in the latest version of TOML. - parse(String, TomlParseOptions) - Static method in class org.tomlj.Toml
-
Parse a TOML string.
- parse(String, TomlVersion) - Static method in class org.tomlj.Toml
-
Parse a TOML string.
- parse(String, TomlVersion) - Static method in interface org.tomlj.TomlValue
-
Parse the text of one value, written as it is after the
=of akey = valueline. - parse(ReadableByteChannel) - Static method in class org.tomlj.Toml
-
Parse a TOML reader.
- parse(ReadableByteChannel, TomlParseOptions) - Static method in class org.tomlj.Toml
-
Parse a TOML input stream.
- parse(ReadableByteChannel, TomlVersion) - Static method in class org.tomlj.Toml
-
Parse a TOML input stream.
- parse(Path) - Static method in class org.tomlj.Toml
-
Parse a TOML file.
- parse(Path, TomlParseOptions) - Static method in class org.tomlj.Toml
-
Parse a TOML file.
- parse(Path, TomlVersion) - Static method in class org.tomlj.Toml
-
Parse a TOML file.
- parseAs(String, Class<T>) - Static method in class org.tomlj.Toml
-
Parse a TOML string and bind it to a Java type, with the default options.
- parseAs(String, Class<T>, TomlBindOptions) - Static method in class org.tomlj.Toml
-
Parse a TOML string and bind it to a Java type.
- parseAs(String, GenericType<T>) - Static method in class org.tomlj.Toml
-
Parse a TOML string and bind it to a generic Java type, with the default options.
- parseAs(String, GenericType<T>, TomlBindOptions) - Static method in class org.tomlj.Toml
-
Parse a TOML string and bind it to a generic Java type.
- parseAs(Path, Class<T>) - Static method in class org.tomlj.Toml
-
Parse a TOML file and bind it to a Java type, with the default options.
- parseAs(Path, Class<T>, TomlBindOptions) - Static method in class org.tomlj.Toml
-
Parse a TOML file and bind it to a Java type.
- parseAs(Path, GenericType<T>) - Static method in class org.tomlj.Toml
-
Parse a TOML file and bind it to a generic Java type, with the default options.
- parseAs(Path, GenericType<T>, TomlBindOptions) - Static method in class org.tomlj.Toml
-
Parse a TOML file and bind it to a generic Java type.
- parseDottedKey(String) - Static method in class org.tomlj.Toml
-
Parse a dotted key into individual parts.
- path() - Method in class org.tomlj.TomlBindError
-
The path of the value within the table or array that was bound.
- placement() - Method in class org.tomlj.TomlComment
-
Where this comment sits relative to the entry it is attached to.
- position() - Method in class org.tomlj.TomlBindError
-
The position of the value in the TOML document.
- position() - Method in class org.tomlj.TomlComment
-
The position of the
#opening the first line of this comment. - position() - Method in interface org.tomlj.TomlElement
-
Where this element was written in the document.
- position() - Method in exception class org.tomlj.TomlParseError
-
The position in the input where the error occurred.
- positionAt(int, int) - Static method in class org.tomlj.TomlPosition
-
Create a position.
R
- reformat(TomlWriteOptions.Keep) - Method in interface org.tomlj.MutableTomlArray
-
Keep less of the existing structure and format of this array, and of everything in it.
- reformat(TomlWriteOptions.Keep) - Method in interface org.tomlj.MutableTomlTable
-
Keep less of the existing structure and format of this table, and of everything in it.
- remove(int) - Method in interface org.tomlj.MutableTomlArray
-
Remove the value at an index.
- remove(String) - Method in interface org.tomlj.MutableTomlTable
-
Remove a value from this table, as
MutableTomlTable.remove(List)does. - remove(List<String>) - Method in interface org.tomlj.MutableTomlTable
-
Remove a value from this table.
- removeComment(int, TomlComment.Placement) - Method in interface org.tomlj.MutableTomlArray
-
Remove the attached comment at a placement, as
MutableTomlEntry.removeComment(TomlComment.Placement)does. - removeComment(String, TomlComment.Placement) - Method in interface org.tomlj.MutableTomlTable
-
Remove the attached comment at a placement, as
MutableTomlEntry.removeComment(TomlComment.Placement)does. - removeComment(List<String>, TomlComment.Placement) - Method in interface org.tomlj.MutableTomlTable
-
Remove the attached comment at a placement, as
MutableTomlEntry.removeComment(TomlComment.Placement)does. - removeComment(TomlComment) - Method in interface org.tomlj.MutableTomlArray
-
Remove an unattached comment, by identity.
- removeComment(TomlComment) - Method in interface org.tomlj.MutableTomlTable
-
Remove an unattached comment, by identity.
- removeComment(TomlComment.Placement) - Method in interface org.tomlj.MutableTomlEntry
-
Remove the attached comment at a placement.
- removeCommentAbove() - Method in interface org.tomlj.MutableTomlEntry
-
Remove the run of comment lines written above this entry.
- removeCommentAbove(int) - Method in interface org.tomlj.MutableTomlArray
-
Remove the run of comment lines written above an entry, as
MutableTomlEntry.removeCommentAbove()does. - removeCommentAbove(String) - Method in interface org.tomlj.MutableTomlTable
-
Remove the run of comment lines written above an entry, as
MutableTomlEntry.removeCommentAbove()does. - removeCommentAbove(List<String>) - Method in interface org.tomlj.MutableTomlTable
-
Remove the run of comment lines written above an entry, as
MutableTomlEntry.removeCommentAbove()does. - removeCommentAfter() - Method in interface org.tomlj.MutableTomlEntry
-
Remove the comment written on this entry's line.
- removeCommentAfter(int) - Method in interface org.tomlj.MutableTomlArray
-
Remove the comment written on an entry's line, as
MutableTomlEntry.removeCommentAfter()does. - removeCommentAfter(String) - Method in interface org.tomlj.MutableTomlTable
-
Remove the comment written on an entry's line, as
MutableTomlEntry.removeCommentAfter()does. - removeCommentAfter(List<String>) - Method in interface org.tomlj.MutableTomlTable
-
Remove the comment written on an entry's line, as
MutableTomlEntry.removeCommentAfter()does. - retainsSource() - Method in class org.tomlj.TomlParseOptions
-
Whether a parse result keeps the source text of the document it was read from.
S
- set(int, Object) - Method in interface org.tomlj.MutableTomlArray
-
Replace the value at an index.
- set(String, Object) - Method in interface org.tomlj.MutableTomlTable
-
Set a value in this table, replacing any value already there, as
MutableTomlTable.set(List, Object)does. - set(List<String>, Object) - Method in interface org.tomlj.MutableTomlTable
-
Set a value in this table, replacing any value already there.
- setComment(int, String, TomlComment.Placement) - Method in interface org.tomlj.MutableTomlArray
-
Set an attached comment on an entry from its text, as
MutableTomlEntry.setComment(String, TomlComment.Placement)does. - setComment(int, TomlComment) - Method in interface org.tomlj.MutableTomlArray
-
Set an attached comment on an entry, as
MutableTomlEntry.setComment(TomlComment)does. - setComment(String, String, TomlComment.Placement) - Method in interface org.tomlj.MutableTomlTable
-
Set an attached comment on an entry from its text, as
MutableTomlEntry.setComment(String, TomlComment.Placement)does. - setComment(String, TomlComment) - Method in interface org.tomlj.MutableTomlTable
-
Set an attached comment on an entry, as
MutableTomlEntry.setComment(TomlComment)does. - setComment(String, TomlComment.Placement) - Method in interface org.tomlj.MutableTomlEntry
-
Set an attached comment from its text, replacing any comment already at
placement. - setComment(List<String>, String, TomlComment.Placement) - Method in interface org.tomlj.MutableTomlTable
-
Set an attached comment on an entry from its text, as
MutableTomlEntry.setComment(String, TomlComment.Placement)does. - setComment(List<String>, TomlComment) - Method in interface org.tomlj.MutableTomlTable
-
Set an attached comment on an entry, as
MutableTomlEntry.setComment(TomlComment)does. - setComment(TomlComment) - Method in interface org.tomlj.MutableTomlEntry
-
Set an attached comment, replacing any comment already at its placement.
- setCommentAbove(int, String...) - Method in interface org.tomlj.MutableTomlArray
-
Set the run of comment lines written above an entry, as
MutableTomlEntry.setCommentAbove(String...)does. - setCommentAbove(int, List<String>) - Method in interface org.tomlj.MutableTomlArray
-
Set the run of comment lines written above an entry, as
MutableTomlEntry.setCommentAbove(List)does. - setCommentAbove(String...) - Method in interface org.tomlj.MutableTomlEntry
-
Set the run of comment lines written above this entry, replacing any already there.
- setCommentAbove(String, String...) - Method in interface org.tomlj.MutableTomlTable
-
Set the run of comment lines written above an entry, as
MutableTomlEntry.setCommentAbove(String...)does. - setCommentAbove(String, List<String>) - Method in interface org.tomlj.MutableTomlTable
-
Set the run of comment lines written above an entry, as
MutableTomlEntry.setCommentAbove(List)does. - setCommentAbove(List<String>) - Method in interface org.tomlj.MutableTomlEntry
-
Set the run of comment lines written above this entry, replacing any already there, as
MutableTomlEntry.setComment(String, TomlComment.Placement)does. - setCommentAbove(List<String>, String...) - Method in interface org.tomlj.MutableTomlTable
-
Set the run of comment lines written above an entry, as
MutableTomlEntry.setCommentAbove(String...)does. - setCommentAbove(List<String>, List<String>) - Method in interface org.tomlj.MutableTomlTable
-
Set the run of comment lines written above an entry, as
MutableTomlEntry.setCommentAbove(List)does. - setCommentAfter(int, String) - Method in interface org.tomlj.MutableTomlArray
-
Set the comment written on an entry's line, as
MutableTomlEntry.setCommentAfter(String)does. - setCommentAfter(String) - Method in interface org.tomlj.MutableTomlEntry
-
Set the comment written on this entry's line, replacing any already there, as
MutableTomlEntry.setComment(String, TomlComment.Placement)does. - setCommentAfter(String, String) - Method in interface org.tomlj.MutableTomlTable
-
Set the comment written on an entry's line, as
MutableTomlEntry.setCommentAfter(String)does. - setCommentAfter(List<String>, String) - Method in interface org.tomlj.MutableTomlTable
-
Set the comment written on an entry's line, as
MutableTomlEntry.setCommentAfter(String)does. - setValue(Object) - Method in interface org.tomlj.MutableTomlEntry
-
Replace the value this entry holds, as
MutableTomlTable.set(java.lang.String, java.lang.Object)orMutableTomlArray.set(int, java.lang.Object)would. - size() - Method in interface org.tomlj.TomlArray
-
The size of the array.
- size() - Method in interface org.tomlj.TomlTable
-
Return the number of entries in tis table.
- SNAKE_CASE - Enum constant in enum class org.tomlj.TomlBindOptions.KeyNaming
-
The words of the name, in lower case, joined by
_:maxConnectionsis bound tomax_connections, andhttpURLtohttp_url. - spaceInsideArrays() - Method in class org.tomlj.TomlWriteOptions
-
Whether an array written on one line has a space inside each bracket.
T
- text() - Method in class org.tomlj.TomlComment
-
The lines of this comment, joined with
\n. - toJson(Appendable, EnumSet<JsonOptions>) - Method in interface org.tomlj.TomlArray
-
Append a JSON representation of this array to the appendable output.
- toJson(Appendable, EnumSet<JsonOptions>) - Method in interface org.tomlj.TomlTable
-
Append a JSON representation of this table to the appendable output.
- toJson(Appendable, JsonOptions...) - Method in interface org.tomlj.TomlArray
-
Append a JSON representation of this array to the appendable output.
- toJson(Appendable, JsonOptions...) - Method in interface org.tomlj.TomlTable
-
Append a JSON representation of this table to the appendable output.
- toJson(EnumSet<JsonOptions>) - Method in interface org.tomlj.TomlArray
-
Return a representation of this array using JSON.
- toJson(EnumSet<JsonOptions>) - Method in interface org.tomlj.TomlTable
-
Return a representation of this table using JSON.
- toJson(JsonOptions...) - Method in interface org.tomlj.TomlArray
-
Return a representation of this array using JSON.
- toJson(JsonOptions...) - Method in interface org.tomlj.TomlTable
-
Return a representation of this table using JSON.
- toList() - Method in interface org.tomlj.TomlArray
-
Get the elements of this array as a
List. - toMap() - Method in interface org.tomlj.TomlTable
-
Get the entries of this table as a
Map. - Toml - Class in org.tomlj
-
Methods for parsing data stored in Tom's Obvious, Minimal Language (TOML), for binding it to Java objects, and for writing Java objects as TOML.
- TomlArray - Interface in org.tomlj
-
An array of TOML values.
- TomlBindError - Class in org.tomlj
-
A value of a TOML document that could not be bound to its Java type.
- TomlBindException - Exception Class in org.tomlj
-
Thrown when a table or array cannot be bound to a Java type.
- TomlBindOptions - Class in org.tomlj
-
Options controlling how a table or array is bound to a Java type, and how a Java object is written as a table or array.
- TomlBindOptions.KeyNaming - Enum Class in org.tomlj
-
How the name of a field or record component is turned into a TOML key.
- TomlCommand - Class in org.tomlj
-
A simple command line tool for parsing TOML and outputing in JSON.
- TomlComment - Class in org.tomlj
-
A comment in a TOML document, either attached to an entry or unattached.
- TomlComment.Placement - Enum Class in org.tomlj
-
Where a comment sits relative to the entry it is attached to.
- TomlElement - Interface in org.tomlj
-
Something written in a table or array: an entry, or an unattached comment.
- TomlEntry - Interface in org.tomlj
-
An entry of a table or array: the slot a container indexes, with the value it holds and the comments attached to it.
- tomlEscape(String) - Static method in class org.tomlj.Toml
-
Escape a text string using the TOML escape sequences.
- TomlInvalidTypeException - Exception Class in org.tomlj
-
An exception thrown when an invalid type is encountered.
- TomlKeyAlreadySetException - Exception Class in org.tomlj
-
An exception thrown when a key to be added to a table is already set in it.
- TomlKeyValue - Interface in org.tomlj
-
A key/value pair written in a table, with the comments attached to it.
- TomlName - Annotation Interface in org.tomlj
-
The name in TOML of a field, record component or enum constant, for
TomlTable.as(Class)andMutableTomlTable.from(Object). - TomlParseError - Exception Class in org.tomlj
-
An error that occurred while parsing.
- TomlParseException - Exception Class in org.tomlj
-
Thrown when a document to be bound has parse errors.
- TomlParseOptions - Class in org.tomlj
-
Options controlling how a TOML document is parsed.
- TomlParseResult - Interface in org.tomlj
-
The result from parsing a TOML document.
- TomlPosition - Class in org.tomlj
-
A position in an input document.
- TomlTable - Interface in org.tomlj
-
An interface for accessing data stored in Tom's Obvious, Minimal Language (TOML).
- TomlValue - Interface in org.tomlj
-
A value written in a document: under a key in a table, or in an array.
- TomlVersion - Enum Class in org.tomlj
-
Supported TOML specification versions.
- TomlWriteOptions - Class in org.tomlj
-
Options controlling how
TomlTable.toToml(TomlWriteOptions)andTomlArray.toToml(TomlWriteOptions)write TOML. - TomlWriteOptions.Keep - Enum Class in org.tomlj
-
How much of the existing document structure and format is kept.
- toString() - Method in class org.tomlj.GenericType
- toString() - Method in class org.tomlj.TomlBindError
- toString() - Method in class org.tomlj.TomlBindOptions
- toString() - Method in class org.tomlj.TomlComment
- toString() - Method in exception class org.tomlj.TomlParseError
- toString() - Method in class org.tomlj.TomlParseOptions
- toString() - Method in class org.tomlj.TomlPosition
- toString() - Method in class org.tomlj.TomlWriteOptions
- toToml() - Method in interface org.tomlj.TomlArray
-
Return a representation of this array using TOML, written with the default options.
- toToml() - Method in interface org.tomlj.TomlTable
-
Return a representation of this table using TOML, written with the default options.
- toToml(Appendable) - Method in interface org.tomlj.TomlArray
-
Append a TOML representation of this array to the appendable output, written with the default options.
- toToml(Appendable) - Method in interface org.tomlj.TomlTable
-
Append a TOML representation of this table to the appendable output, written with the default options.
- toToml(Appendable, TomlWriteOptions) - Method in interface org.tomlj.TomlArray
-
Append a TOML representation of this array to the appendable output.
- toToml(Appendable, TomlWriteOptions) - Method in interface org.tomlj.TomlTable
-
Append a TOML representation of this table to the appendable output.
- toToml(Object) - Static method in class org.tomlj.Toml
-
Write a record, class or map as a TOML document, with the default options.
- toToml(Object, TomlBindOptions) - Static method in class org.tomlj.Toml
-
Write a record, class or map as a TOML document, with the default write options.
- toToml(Object, TomlBindOptions, TomlWriteOptions) - Static method in class org.tomlj.Toml
-
Write a record, class or map as a TOML document.
- toToml(TomlWriteOptions) - Method in interface org.tomlj.TomlArray
-
Return a representation of this array using TOML.
- toToml(TomlWriteOptions) - Method in interface org.tomlj.TomlTable
-
Return a representation of this table using TOML.
- type() - Method in class org.tomlj.GenericType
-
The type named.
U
- UNATTACHED - Enum constant in enum class org.tomlj.TomlComment.Placement
-
A comment attached to no entry: a run that is not directly above one, or a comment on a line with none.
- update(Object) - Method in interface org.tomlj.MutableTomlArray
-
Update this array to hold the elements of a collection or Java array, with the default options.
- update(Object) - Method in interface org.tomlj.MutableTomlTable
-
Update this table to hold the members of a record or class, or the entries of a map, with the default options.
- update(Object, TomlBindOptions) - Method in interface org.tomlj.MutableTomlArray
-
Update this array to hold the elements of a collection or Java array, changing only the values that differ.
- update(Object, TomlBindOptions) - Method in interface org.tomlj.MutableTomlTable
-
Update this table to hold the members of a record or class, or the entries of a map, changing only the values that differ.
V
- V1_0_0 - Enum constant in enum class org.tomlj.TomlVersion
-
The 1.0.0 version of TOML.
- V1_1_0 - Enum constant in enum class org.tomlj.TomlVersion
-
The 1.1.0 version of TOML.
- value() - Method in interface org.tomlj.TomlEntry
-
The value this entry holds.
- value() - Element in annotation interface org.tomlj.TomlName
-
The name.
- valueOf(String) - Static method in enum class org.tomlj.JsonOptions
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.tomlj.TomlBindOptions.KeyNaming
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.tomlj.TomlComment.Placement
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.tomlj.TomlVersion
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.tomlj.TomlWriteOptions.Keep
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.tomlj.JsonOptions
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.tomlj.TomlBindOptions.KeyNaming
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.tomlj.TomlComment.Placement
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.tomlj.TomlVersion
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.tomlj.TomlWriteOptions.Keep
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VALUES_AS_OBJECTS_WITH_TYPE - Enum constant in enum class org.tomlj.JsonOptions
-
Output values as objects including a "type" and "value" property.
- version() - Method in class org.tomlj.TomlParseOptions
-
The version level to parse at.
- version() - Method in class org.tomlj.TomlWriteOptions
-
The version of TOML the output is written for,
TomlVersion.LATESTby default.
W
- withBlankLineBetweenNestedHeaders(boolean) - Method in class org.tomlj.TomlWriteOptions
-
Create a copy of these options that does or does not write a blank line between a table header and the header of a table within it that directly follows it.
- withConverter(Class<T>, Function<Object, ? extends T>) - Method in class org.tomlj.TomlBindOptions
-
Create a copy of these options that binds values to a type with a converter.
- withConverter(Class<T>, Function<Object, ? extends T>, Function<? super T, ?>) - Method in class org.tomlj.TomlBindOptions
-
Create a copy of these options that binds values to a type with a converter, and writes values of the type with another.
- withEntriesAlignedWithHeaders(boolean) - Method in class org.tomlj.TomlWriteOptions
-
Create a copy of these options that indents the entries of a table like its header, or one level beyond it.
- withIndent(int) - Method in class org.tomlj.TomlWriteOptions
-
Create a copy of these options that indents nested tables.
- withKeyNaming(TomlBindOptions.KeyNaming) - Method in class org.tomlj.TomlBindOptions
-
Create a copy of these options that turns names into keys with a different key naming.
- withLineSeparator(String) - Method in class org.tomlj.TomlWriteOptions
-
Create a copy of these options that ends each line with a different line separator.
- withMaxLineWidth(int) - Method in class org.tomlj.TomlWriteOptions
-
Create a copy of these options with a different maximum line width.
- withMaxNestingDepth(int) - Method in class org.tomlj.TomlParseOptions
-
Create a copy of these options that allows a different maximum nesting depth.
- withoutSource() - Method in class org.tomlj.TomlParseOptions
-
Create a copy of these options that keeps no source text.
- withSpaceInsideArrays(boolean) - Method in class org.tomlj.TomlWriteOptions
-
Create a copy of these options that writes an array on one line with a space inside each bracket,
[ 1, 2 ], or without,[1, 2]. - withUnknownKeysIgnored(boolean) - Method in class org.tomlj.TomlBindOptions
-
Create a copy of these options that ignores keys with no field or record component, or that reports them.
- withVersion(TomlVersion) - Method in class org.tomlj.TomlParseOptions
-
Create a copy of these options that parses at a different specification version.
- withVersion(TomlVersion) - Method in class org.tomlj.TomlWriteOptions
-
Create a copy of these options that writes for a different version of TOML.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form