All Superinterfaces:: TomlTable

All Known Subinterfaces:: TomlParseResult

public interface MutableTomlTable extends TomlTable

A TomlTable whose values can be edited in place.

A value set through this interface is any value a TomlTable can hold. An Integer, Short or Byte is widened to a Long and a Float to a Double; a Map with String keys becomes a table and a Collection an array, their values converted the same way; a TomlValue stores what it holds. null throws a NullPointerException and anything else an IllegalArgumentException.

A key or a String value must not contain an unpaired surrogate, an OffsetDateTime's offset must be a whole number of minutes, and a LocalDate, LocalDateTime or OffsetDateTime must have a year between 0 and 9999, since none of these can be written as TOML.

A TomlTable or TomlArray stored as a value is stored as a deep copy, so later changes to the original are not seen; the stored copy is edited through the getters that return it.

An entry's attached comments are edited through its MutableTomlKeyValue (or MutableTomlEntry) obtained from entry(java.lang.String), or through the shortcuts here. An unattached comment is added after the last element with addComment(java.lang.String...) and removed with removeComment(java.lang.String, org.tomlj.TomlComment.Placement); it can also be inserted before or after an entry with insertCommentBefore(java.lang.String, java.lang.String...) or insertCommentAfter(java.lang.String, java.lang.String...). An entry or a comment can also be inserted before or after any element of this table's sequence, as TomlTable.elements() returns it, with insertBefore(java.lang.String, java.lang.String, java.lang.Object), insertAfter(java.lang.String, java.lang.String, java.lang.Object), insertCommentBefore(java.lang.String, java.lang.String...), or insertCommentAfter(java.lang.String, java.lang.String...).

A table is written back out with TomlTable.toToml(), and reformat(TomlWriteOptions.Keep) makes it, and everything nested in it, keep less of its existing structure and format.

Not safe for use from multiple threads without external synchronization.

Method Summary

Modifier and Type

Method

Description

default MutableTomlTable

addComment(String... lines)

Add an unattached comment, after the elements already written, as addComment(List) does.

default MutableTomlTable

addComment(List<String> lines)

Add an unattached comment, after the elements already written.

MutableTomlTable

addComment(TomlComment comment)

Add a comment, after the elements already written.

void

clear()

Remove every entry from this table.

static MutableTomlTable

copyOf(Map<String,?> map)

Create a table from a Map.

static MutableTomlTable

copyOf(TomlTable table)

Create a deep copy of a table.

static MutableTomlTable

create()

Create a new, empty table.

static MutableTomlTable

createInline()

Create a new, empty inline table.

default @Nullable MutableTomlKeyValue

entry(String dottedKey)

Get the entry for a key.

@Nullable MutableTomlKeyValue

entry(List<String> path)

Get the entry for a key.

default @Nullable MutableTomlArray

getArray(String dottedKey)

Get an array from the TOML document.

default @Nullable MutableTomlArray

getArray(List<String> path)

Get an array from the TOML document.

default MutableTomlArray

getOrCreateArray(String dottedKey)

Get the array at a key, creating it, and any intermediate table that does not already exist, if necessary.

MutableTomlArray

getOrCreateArray(List<String> path)

Get the array at a path, creating it, and any intermediate table that does not already exist, if necessary.

default MutableTomlTable

getOrCreateTable(String dottedKey)

Get the table at a key, creating it, and any intermediate table that does not already exist, if necessary.

MutableTomlTable

getOrCreateTable(List<String> path)

Get the table at a path, creating it, and any intermediate table that does not already exist, if necessary.

default @Nullable MutableTomlTable

getTable(String dottedKey)

Get a table from the TOML document.

default @Nullable MutableTomlTable

getTable(List<String> path)

Get a table from the TOML document.

default MutableTomlTable

insertAfter(String anchorDottedKey, String key, Object value)

Insert a value into this table after an existing entry, as insertAfter(List, String, Object) does.

MutableTomlTable

insertAfter(List<String> anchorPath, String key, Object value)

Insert a value into this table after an existing entry.

MutableTomlTable

insertAfter(TomlElement anchor, String key, Object value)

Insert a value into this table immediately after an element of its sequence.

default MutableTomlTable

insertBefore(String anchorDottedKey, String key, Object value)

Insert a value into this table before an existing entry, as insertBefore(List, String, Object) does.

MutableTomlTable

insertBefore(List<String> anchorPath, String key, Object value)

Insert a value into this table before an existing entry.

MutableTomlTable

insertBefore(TomlElement anchor, String key, Object value)

Insert a value into this table immediately before an element of its sequence.

default MutableTomlTable

insertCommentAfter(String anchorDottedKey, String... lines)

Insert an unattached comment into this table after an existing entry, as insertCommentAfter(List, List) does.

default MutableTomlTable

insertCommentAfter(String anchorDottedKey, List<String> lines)

Insert an unattached comment into this table after an existing entry, as insertCommentAfter(List, List) does.

default MutableTomlTable

insertCommentAfter(String anchorDottedKey, TomlComment comment)

Insert a comment into this table after an existing entry, as insertCommentAfter(List, TomlComment) does.

default MutableTomlTable

insertCommentAfter(List<String> anchorPath, String... lines)

Insert an unattached comment into this table after an existing entry, as insertCommentAfter(List, List) does.

default MutableTomlTable

insertCommentAfter(List<String> anchorPath, List<String> lines)

Insert an unattached comment into this table after an existing entry, as insertCommentAfter(List, TomlComment) places one.

MutableTomlTable

insertCommentAfter(List<String> anchorPath, TomlComment comment)

Insert a comment into this table after an existing entry.

default MutableTomlTable

insertCommentAfter(TomlElement anchor, String... lines)

Insert an unattached comment into this table immediately after an element of its sequence, as insertCommentAfter(TomlElement, List) does.

default MutableTomlTable

insertCommentAfter(TomlElement anchor, List<String> lines)

Insert an unattached comment into this table immediately after an element of its sequence, as insertCommentAfter(TomlElement, TomlComment) places one.

MutableTomlTable

insertCommentAfter(TomlElement anchor, TomlComment comment)

Insert a comment into this table immediately after an element of its sequence.

default MutableTomlTable

insertCommentBefore(String anchorDottedKey, String... lines)

Insert an unattached comment into this table before an existing entry, as insertCommentBefore(List, List) does.

default MutableTomlTable

insertCommentBefore(String anchorDottedKey, List<String> lines)

Insert an unattached comment into this table before an existing entry, as insertCommentBefore(List, List) does.

default MutableTomlTable

insertCommentBefore(String anchorDottedKey, TomlComment comment)

Insert a comment into this table before an existing entry, as insertCommentBefore(List, TomlComment) does.

default MutableTomlTable

insertCommentBefore(List<String> anchorPath, String... lines)

Insert an unattached comment into this table before an existing entry, as insertCommentBefore(List, List) does.

default MutableTomlTable

insertCommentBefore(List<String> anchorPath, List<String> lines)

Insert an unattached comment into this table before an existing entry, as insertCommentBefore(List, TomlComment) places one.

MutableTomlTable

insertCommentBefore(List<String> anchorPath, TomlComment comment)

Insert a comment into this table before an existing entry.

default MutableTomlTable

insertCommentBefore(TomlElement anchor, String... lines)

Insert an unattached comment into this table immediately before an element of its sequence, as insertCommentBefore(TomlElement, List) does.

default MutableTomlTable

insertCommentBefore(TomlElement anchor, List<String> lines)

Insert an unattached comment into this table immediately before an element of its sequence, as insertCommentBefore(TomlElement, TomlComment) places one.

MutableTomlTable

insertCommentBefore(TomlElement anchor, TomlComment comment)

Insert a comment into this table immediately before an element of its sequence.

boolean

isModified()

Whether this table was changed through this interface.

default boolean

isModified(String dottedKey)

Whether an entry of this table was changed through this interface, as isModified(List) reports.

boolean

isModified(List<String> path)

Whether an entry of this table was changed through this interface.

MutableTomlTable

reformat(TomlWriteOptions.Keep keep)

Keep less of the existing structure and format of this table, and of everything in it.

default @Nullable Object

remove(String dottedKey)

Remove a value from this table, as remove(List) does.

@Nullable Object

remove(List<String> path)

Remove a value from this table.

default MutableTomlTable

removeComment(String dottedKey, TomlComment.Placement placement)

Remove the attached comment at a placement, as MutableTomlEntry.removeComment(TomlComment.Placement) does.

default MutableTomlTable

removeComment(List<String> path, TomlComment.Placement placement)

Remove the attached comment at a placement, as MutableTomlEntry.removeComment(TomlComment.Placement) does.

boolean

removeComment(TomlComment comment)

Remove an unattached comment, by identity.

default MutableTomlTable

removeCommentAbove(String dottedKey)

Remove the run of comment lines written above an entry, as MutableTomlEntry.removeCommentAbove() does.

default MutableTomlTable

removeCommentAbove(List<String> path)

Remove the run of comment lines written above an entry, as MutableTomlEntry.removeCommentAbove() does.

default MutableTomlTable

removeCommentAfter(String dottedKey)

Remove the comment written on an entry's line, as MutableTomlEntry.removeCommentAfter() does.

default MutableTomlTable

removeCommentAfter(List<String> path)

Remove the comment written on an entry's line, as MutableTomlEntry.removeCommentAfter() does.

default MutableTomlTable

set(String dottedKey, Object value)

Set a value in this table, replacing any value already there, as set(List, Object) does.

MutableTomlTable

set(List<String> path, Object value)

Set a value in this table, replacing any value already there.

default MutableTomlTable

setComment(String dottedKey, String text, TomlComment.Placement placement)

Set an attached comment on an entry from its text, as MutableTomlEntry.setComment(String, TomlComment.Placement) does.

default MutableTomlTable

setComment(String dottedKey, TomlComment comment)

Set an attached comment on an entry, as MutableTomlEntry.setComment(TomlComment) does.

default MutableTomlTable

setComment(List<String> path, String text, TomlComment.Placement placement)

Set an attached comment on an entry from its text, as MutableTomlEntry.setComment(String, TomlComment.Placement) does.

default MutableTomlTable

setComment(List<String> path, TomlComment comment)

Set an attached comment on an entry, as MutableTomlEntry.setComment(TomlComment) does.

default MutableTomlTable

setCommentAbove(String dottedKey, String... lines)

Set the run of comment lines written above an entry, as MutableTomlEntry.setCommentAbove(String...) does.

default MutableTomlTable

setCommentAbove(String dottedKey, List<String> lines)

Set the run of comment lines written above an entry, as MutableTomlEntry.setCommentAbove(List) does.

default MutableTomlTable

setCommentAbove(List<String> path, String... lines)

Set the run of comment lines written above an entry, as MutableTomlEntry.setCommentAbove(String...) does.

default MutableTomlTable

setCommentAbove(List<String> path, List<String> lines)

Set the run of comment lines written above an entry, as MutableTomlEntry.setCommentAbove(List) does.

default MutableTomlTable

setCommentAfter(String dottedKey, String text)

Set the comment written on an entry's line, as MutableTomlEntry.setCommentAfter(String) does.

default MutableTomlTable

setCommentAfter(List<String> path, String text)

Set the comment written on an entry's line, as MutableTomlEntry.setCommentAfter(String) does.

Methods inherited from interface org.tomlj.TomlTable
comment, comment, comments, comments, contains, contains, dottedEntrySet, dottedEntrySet, dottedKeySet, dottedKeySet, elements, entryPathSet, entryPathSet, entrySet, get, get, getArrayOrEmpty, getArrayOrEmpty, getBoolean, getBoolean, getBoolean, getBoolean, getDouble, getDouble, getDouble, getDouble, getLocalDate, getLocalDate, getLocalDate, getLocalDate, getLocalDateTime, getLocalDateTime, getLocalDateTime, getLocalDateTime, getLocalTime, getLocalTime, getLocalTime, getLocalTime, getLong, getLong, getLong, getLong, getOffsetDateTime, getOffsetDateTime, getOffsetDateTime, getOffsetDateTime, getString, getString, getString, getString, getTableOrEmpty, getTableOrEmpty, inputPositionOf, inputPositionOf, isArray, isArray, isBoolean, isBoolean, isDouble, isDouble, isEmpty, isLocalDate, isLocalDate, isLocalDateTime, isLocalDateTime, isLocalTime, isLocalTime, isLong, isLong, isOffsetDateTime, isOffsetDateTime, isString, isString, isTable, isTable, keyPathSet, keyPathSet, keySet, size, toJson, toJson, toJson, toJson, toMap, toToml, toToml, toToml, toToml

Method Details
- create
  
  static MutableTomlTable create()
  
  Create a new, empty table.
  
  Returns:
  
  A new, empty table.
- createInline
  
  static MutableTomlTable createInline()
  
  Create a new, empty inline table.
  The table is written with braces on the line of the entry holding it, as t = { a = 1 }, rather than under a [t] header, unless the document is written keeping nothing (TomlWriteOptions.Keep.NOTHING). A table made with create() is written in whichever form the default style chooses for it.
  
  Returns:
  
  A new, empty inline table.
- getOrCreateTable
  
  default MutableTomlTable getOrCreateTable(String dottedKey)
  
  Get the table at a key, creating it, and any intermediate table that does not already exist, if necessary.
  
  Parameters:
  
  dottedKey - A dotted key (e.g. "server.address").
  
  Returns:
  
  The table.
  
  Throws:
  
  IllegalArgumentException - If the key cannot be parsed, or contains an unpaired surrogate.
  
  TomlInvalidTypeException - If an element of the path exists and is not a table.
- getOrCreateTable
  
  MutableTomlTable getOrCreateTable(List<String> path)
  
  Get the table at a path, creating it, and any intermediate table that does not already exist, if necessary.
  A table created here is an entry with no position and no comments.
  
  Parameters:
  
  path - The key path.
  
  Returns:
  
  The table, or this table if path is empty.
  
  Throws:
  
  NullPointerException - If a path element is null.
  
  IllegalArgumentException - If a path element contains an unpaired surrogate.
  
  TomlInvalidTypeException - If an element of the path exists and is not a table.
- getOrCreateArray
  
  default MutableTomlArray getOrCreateArray(String dottedKey)
  
  Get the array at a key, creating it, and any intermediate table that does not already exist, if necessary.
  
  Parameters:
  
  dottedKey - A dotted key (e.g. "server.addresses").
  
  Returns:
  
  The array.
  
  Throws:
  
  IllegalArgumentException - If the key cannot be parsed, or contains an unpaired surrogate.
  
  TomlInvalidTypeException - If the value exists and is not an array, or an element of the path preceding the final key exists and is not a table.
- getOrCreateArray
  
  MutableTomlArray getOrCreateArray(List<String> path)
  
  Get the array at a path, creating it, and any intermediate table that does not already exist, if necessary.
  An array or table created here is an entry with no position and no comments.
  
  Parameters:
  
  path - The key path.
  
  Returns:
  
  The array.
  
  Throws:
  
  IllegalArgumentException - If path is empty, or a path element contains an unpaired surrogate.
  
  NullPointerException - If a path element is null.
  
  TomlInvalidTypeException - If the value exists and is not an array, or an element of the path preceding the final key exists and is not a table.
- set
  
  default MutableTomlTable set(String dottedKey, Object value)
  
  Set a value in this table, replacing any value already there, as set(List, Object) does.
  
  Parameters:
  
  dottedKey - A dotted key (e.g. "server.address.port").
  
  value - The value to set.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If dottedKey or value is null.
  
  IllegalArgumentException - If the key cannot be parsed or contains an unpaired surrogate, or value cannot be converted to a TOML value or cannot be written as TOML.
  
  TomlInvalidTypeException - If an element of the path preceding the final key exists and is not a table.
- set
  
  MutableTomlTable set(List<String> path, Object value)
  
  Set a value in this table, replacing any value already there.
  Any intermediate table on the path that does not exist is created. Replacing a value keeps the entry: its position, its place in iteration order and its attached comments. Adding one creates an entry with no position and no comments. A table or array is stored as a deep copy, made as copyOf(TomlTable) makes one, so it has no positions.
  A rejected call leaves this table as it was: value is converted before any intermediate table is created.
  
  Parameters:
  
  path - The key path.
  
  value - The value to set.
  
  Returns:
  
  This table.
  
  Throws:
  
  IllegalArgumentException - If path is empty, a path element contains an unpaired surrogate, or value cannot be converted to a TOML value or cannot be written as TOML.
  
  NullPointerException - If a path element, or value, is null.
  
  TomlInvalidTypeException - If an element of the path preceding the final key exists and is not a table.
- insertBefore
  
  default MutableTomlTable insertBefore(String anchorDottedKey, String key, Object value)
  
  Insert a value into this table before an existing entry, as insertBefore(List, String, Object) does.
  
  Parameters:
  
  anchorDottedKey - A dotted key naming the entry to insert beside (e.g. "server.address").
  
  key - The key of the new entry, a single literal key, not a dotted key.
  
  value - The value to set.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If anchorDottedKey, key, or value is null.
  
  IllegalArgumentException - If the anchor key cannot be parsed, key contains an unpaired surrogate, or value cannot be converted to a TOML value or cannot be written as TOML.
  
  NoSuchElementException - If the anchor is not set.
  
  TomlKeyAlreadySetException - If key is already set in the anchor's table.
  
  TomlInvalidTypeException - If an element of the anchor path preceding the final key exists and is not a table.
- insertBefore
  
  MutableTomlTable insertBefore(List<String> anchorPath, String key, Object value)
  
  Insert a value into this table before an existing entry.
  The anchor is the path of an existing entry; the new entry is placed immediately before it, in the table that holds it. key is one literal key in that table, not a dotted key. The new entry has no position and no attached comments, and value is converted as set(List, Object) converts one.
  A rejected call leaves this table as it was: value is converted before the anchor path is walked.
  
  Parameters:
  
  anchorPath - The key path of the existing entry to insert beside.
  
  key - The key of the new entry.
  
  value - The value to set.
  
  Returns:
  
  This table.
  
  Throws:
  
  IllegalArgumentException - If anchorPath is empty, key contains an unpaired surrogate, or value cannot be converted to a TOML value or cannot be written as TOML.
  
  NoSuchElementException - If the anchor is not set.
  
  TomlKeyAlreadySetException - If key is already set in the anchor's table.
  
  NullPointerException - If an element of anchorPath, key, or value is null.
  
  TomlInvalidTypeException - If an element of anchorPath preceding the final key exists and is not a table.
- insertAfter
  
  default MutableTomlTable insertAfter(String anchorDottedKey, String key, Object value)
  
  Insert a value into this table after an existing entry, as insertAfter(List, String, Object) does.
  
  Parameters:
  
  anchorDottedKey - A dotted key naming the entry to insert beside (e.g. "server.address").
  
  key - The key of the new entry, a single literal key, not a dotted key.
  
  value - The value to set.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If anchorDottedKey, key, or value is null.
  
  IllegalArgumentException - If the anchor key cannot be parsed, key contains an unpaired surrogate, or value cannot be converted to a TOML value or cannot be written as TOML.
  
  NoSuchElementException - If the anchor is not set.
  
  TomlKeyAlreadySetException - If key is already set in the anchor's table.
  
  TomlInvalidTypeException - If an element of the anchor path preceding the final key exists and is not a table.
- insertAfter
  
  MutableTomlTable insertAfter(List<String> anchorPath, String key, Object value)
  
  Insert a value into this table after an existing entry.
  The anchor is the path of an existing entry; the new entry is placed immediately after it, in the table that holds it. key is one literal key in that table, not a dotted key. The new entry has no position and no attached comments, and value is converted as set(List, Object) converts one.
  A rejected call leaves this table as it was: value is converted before the anchor path is walked.
  
  Parameters:
  
  anchorPath - The key path of the existing entry to insert beside.
  
  key - The key of the new entry.
  
  value - The value to set.
  
  Returns:
  
  This table.
  
  Throws:
  
  IllegalArgumentException - If anchorPath is empty, key contains an unpaired surrogate, or value cannot be converted to a TOML value or cannot be written as TOML.
  
  NoSuchElementException - If the anchor is not set.
  
  TomlKeyAlreadySetException - If key is already set in the anchor's table.
  
  NullPointerException - If an element of anchorPath, key, or value is null.
  
  TomlInvalidTypeException - If an element of anchorPath preceding the final key exists and is not a table.
- insertBefore
  
  MutableTomlTable insertBefore(TomlElement anchor, String key, Object value)
  
  Insert a value into this table immediately before an element of its sequence.
  The anchor is an element of this table's own TomlTable.elements(), matched by identity: an element of a sub-table, a copy, or another document is rejected, even if it is equal. It may be an entry or an unattached comment; "before an entry" means before the entry itself, so a comment attached above it stays attached to it. The new entry has no position and no attached comments, and value is converted as set(List, Object) converts one.
  A rejected call leaves this table as it was: value is converted before anchor is checked.
  
  Parameters:
  
  anchor - The element to insert before.
  
  key - The key of the new entry.
  
  value - The value to set.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If anchor, key, or value is null.
  
  IllegalArgumentException - If key contains an unpaired surrogate, or value cannot be converted to a TOML value or cannot be written as TOML.
  
  NoSuchElementException - If anchor is not an element of this table's TomlTable.elements().
  
  TomlKeyAlreadySetException - If key is already set in this table.
- insertAfter
  
  MutableTomlTable insertAfter(TomlElement anchor, String key, Object value)
  
  Insert a value into this table immediately after an element of its sequence.
  The new entry is placed immediately after anchor, matched as insertBefore(TomlElement, String, Object) matches one. The new entry has no position and no attached comments, and value is converted as set(List, Object) converts one.
  A rejected call leaves this table as it was: value is converted before anchor is checked.
  
  Parameters:
  
  anchor - The element to insert after.
  
  key - The key of the new entry.
  
  value - The value to set.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If anchor, key, or value is null.
  
  IllegalArgumentException - If key contains an unpaired surrogate, or value cannot be converted to a TOML value or cannot be written as TOML.
  
  NoSuchElementException - If anchor is not an element of this table's TomlTable.elements().
  
  TomlKeyAlreadySetException - If key is already set in this table.
- remove
  
  default @Nullable Object remove(String dottedKey)
  
  Remove a value from this table, as remove(List) does.
  
  Parameters:
  
  dottedKey - A dotted key (e.g. "server.address.port").
  
  Returns:
  
  The value that was removed, or null if the key was not set.
  
  Throws:
  
  IllegalArgumentException - If the key cannot be parsed.
  
  TomlInvalidTypeException - If an element of the path preceding the final key exists and is not a table.
- remove
  
  @Nullable Object remove(List<String> path)
  
  Remove a value from this table.
  The entry is removed, with the comments attached to it. The unattached comments among this table's elements stay where they are.
  
  Parameters:
  
  path - The key path.
  
  Returns:
  
  The value that was removed, or null if the key was not set, or if an element of the path preceding the final key is missing.
  
  Throws:
  
  IllegalArgumentException - If path is empty.
  
  NullPointerException - If a path element is null.
  
  TomlInvalidTypeException - If an element of the path preceding the final key exists and is not a table.
- clear
  
  void clear()
  
  Remove every entry from this table.
  The unattached comments among this table's elements stay where they are. Clearing a table that is already empty is not a modification.
- isModified
  
  boolean isModified()
  
  Whether this table was changed through this interface.
  A change is an entry added, replaced or removed, in this table or in any table or array nested within it. A table read from a document, or newly created, reports false; nothing resets this once it is true.
  
  Returns:
  
  true if this table was changed through this interface.
- isModified
  
  default boolean isModified(String dottedKey)
  
  Whether an entry of this table was changed through this interface, as isModified(List) reports.
  
  Parameters:
  
  dottedKey - A dotted key (e.g. "server.address.port").
  
  Returns:
  
  true if the entry was changed; false if the key is not set.
  
  Throws:
  
  IllegalArgumentException - If the key cannot be parsed.
- isModified
  
  boolean isModified(List<String> path)
  
  Whether an entry of this table was changed through this interface.
  A change is the entry added or replaced, or a change within the table or array it holds.
  
  Parameters:
  
  path - The key path.
  
  Returns:
  
  true if the entry was changed; false if the key is not set. Equivalent to isModified() if path is empty.
- setCommentAbove
  
  default MutableTomlTable setCommentAbove(String dottedKey, String... lines)
  
  Set the run of comment lines written above an entry, as MutableTomlEntry.setCommentAbove(String...) does.
  
  Parameters:
  
  dottedKey - A dotted key (e.g. "server.address.port").
  
  lines - The text of each line, as TomlComment.lines() would return it; a line holding a newline is split there.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If dottedKey, or a line, is null.
  
  IllegalArgumentException - If the key cannot be parsed, lines is empty, or a line cannot be written as a TOML comment.
  
  NoSuchElementException - If the key is not set.
  
  TomlInvalidTypeException - If an element of the path preceding the final key is not a table.
- setCommentAbove
  
  default MutableTomlTable setCommentAbove(String dottedKey, List<String> lines)
  
  Set the run of comment lines written above an entry, as MutableTomlEntry.setCommentAbove(List) does.
  
  Parameters:
  
  dottedKey - A dotted key (e.g. "server.address.port").
  
  lines - The text of each line, as TomlComment.lines() would return it; a line holding a newline is split there.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If dottedKey, lines, or a line is null.
  
  IllegalArgumentException - If the key cannot be parsed, lines is empty, or a line cannot be written as a TOML comment.
  
  NoSuchElementException - If the key is not set.
  
  TomlInvalidTypeException - If an element of the path preceding the final key is not a table.
- setCommentAbove
  
  default MutableTomlTable setCommentAbove(List<String> path, String... lines)
  
  Set the run of comment lines written above an entry, as MutableTomlEntry.setCommentAbove(String...) does.
  
  Parameters:
  
  path - The key path.
  
  lines - The text of each line, as TomlComment.lines() would return it; a line holding a newline is split there.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If a path element, or a line, is null.
  
  IllegalArgumentException - If path is empty, lines is empty, or a line cannot be written as a TOML comment.
  
  NoSuchElementException - If the key is not set.
  
  TomlInvalidTypeException - If an element of the path preceding the final key is not a table.
- setCommentAbove
  
  default MutableTomlTable setCommentAbove(List<String> path, List<String> lines)
  
  Set the run of comment lines written above an entry, as MutableTomlEntry.setCommentAbove(List) does.
  
  Parameters:
  
  path - The key path.
  
  lines - The text of each line, as TomlComment.lines() would return it; a line holding a newline is split there.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If a path element, or a line, is null.
  
  IllegalArgumentException - If path is empty, lines is empty, or a line cannot be written as a TOML comment.
  
  NoSuchElementException - If the key is not set.
  
  TomlInvalidTypeException - If an element of the path preceding the final key is not a table.
- setCommentAfter
  
  default MutableTomlTable setCommentAfter(String dottedKey, String text)
  
  Set the comment written on an entry's line, as MutableTomlEntry.setCommentAfter(String) does.
  
  Parameters:
  
  dottedKey - A dotted key (e.g. "server.address.port").
  
  text - The comment text, as TomlComment.lines() would return its one line.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If dottedKey, or text, is null.
  
  IllegalArgumentException - If the key cannot be parsed, or text cannot be written as a TOML comment.
  
  NoSuchElementException - If the key is not set.
  
  TomlInvalidTypeException - If an element of the path preceding the final key is not a table.
- setCommentAfter
  
  default MutableTomlTable setCommentAfter(List<String> path, String text)
  
  Set the comment written on an entry's line, as MutableTomlEntry.setCommentAfter(String) does.
  
  Parameters:
  
  path - The key path.
  
  text - The comment text, as TomlComment.lines() would return its one line.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If a path element, or text, is null.
  
  IllegalArgumentException - If path is empty, or text cannot be written as a TOML comment.
  
  NoSuchElementException - If the key is not set.
  
  TomlInvalidTypeException - If an element of the path preceding the final key is not a table.
- setComment
  
  default MutableTomlTable setComment(String dottedKey, String text, TomlComment.Placement placement)
  
  Set an attached comment on an entry from its text, as MutableTomlEntry.setComment(String, TomlComment.Placement) does.
  
  Parameters:
  
  dottedKey - A dotted key (e.g. "server.address.port").
  
  text - The comment's text, as TomlComment.text() would return it.
  
  placement - Where the comment sits relative to the entry, TomlComment.Placement.ABOVE or TomlComment.Placement.AFTER.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If dottedKey, text, or placement is null.
  
  IllegalArgumentException - If the key cannot be parsed, placement is TomlComment.Placement.UNATTACHED, or a line of text cannot be written as a TOML comment.
  
  NoSuchElementException - If the key is not set.
  
  TomlInvalidTypeException - If an element of the path preceding the final key is not a table.
- setComment
  
  default MutableTomlTable setComment(List<String> path, String text, TomlComment.Placement placement)
  
  Set an attached comment on an entry from its text, as MutableTomlEntry.setComment(String, TomlComment.Placement) does.
  
  Parameters:
  
  path - The key path.
  
  text - The comment's text, as TomlComment.text() would return it.
  
  placement - Where the comment sits relative to the entry, TomlComment.Placement.ABOVE or TomlComment.Placement.AFTER.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If a path element, text, or placement is null.
  
  IllegalArgumentException - If path is empty, placement is TomlComment.Placement.UNATTACHED, or a line of text cannot be written as a TOML comment.
  
  NoSuchElementException - If the key is not set.
  
  TomlInvalidTypeException - If an element of the path preceding the final key is not a table.
- setComment
  
  default MutableTomlTable setComment(String dottedKey, TomlComment comment)
  
  Set an attached comment on an entry, as MutableTomlEntry.setComment(TomlComment) does.
  
  Parameters:
  
  dottedKey - A dotted key (e.g. "server.address.port").
  
  comment - The comment, with TomlComment.placement() either TomlComment.Placement.ABOVE or TomlComment.Placement.AFTER.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If dottedKey, or comment, is null.
  
  IllegalArgumentException - If the key cannot be parsed, or comment is unattached.
  
  NoSuchElementException - If the key is not set.
  
  TomlInvalidTypeException - If an element of the path preceding the final key is not a table.
- setComment
  
  default MutableTomlTable setComment(List<String> path, TomlComment comment)
  
  Set an attached comment on an entry, as MutableTomlEntry.setComment(TomlComment) does.
  
  Parameters:
  
  path - The key path.
  
  comment - The comment, with TomlComment.placement() either TomlComment.Placement.ABOVE or TomlComment.Placement.AFTER.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If a path element, or comment, is null.
  
  IllegalArgumentException - If path is empty, or comment is unattached.
  
  NoSuchElementException - If the key is not set.
  
  TomlInvalidTypeException - If an element of the path preceding the final key is not a table.
- removeCommentAbove
  
  default MutableTomlTable removeCommentAbove(String dottedKey)
  
  Remove the run of comment lines written above an entry, as MutableTomlEntry.removeCommentAbove() does.
  
  Parameters:
  
  dottedKey - A dotted key (e.g. "server.address.port").
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If dottedKey is null.
  
  IllegalArgumentException - If the key cannot be parsed.
  
  NoSuchElementException - If the key is not set.
  
  TomlInvalidTypeException - If an element of the path preceding the final key is not a table.
- removeCommentAbove
  
  default MutableTomlTable removeCommentAbove(List<String> path)
  
  Remove the run of comment lines written above an entry, as MutableTomlEntry.removeCommentAbove() does.
  
  Parameters:
  
  path - The key path.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If a path element is null.
  
  IllegalArgumentException - If path is empty.
  
  NoSuchElementException - If the key is not set.
  
  TomlInvalidTypeException - If an element of the path preceding the final key is not a table.
- removeCommentAfter
  
  default MutableTomlTable removeCommentAfter(String dottedKey)
  
  Remove the comment written on an entry's line, as MutableTomlEntry.removeCommentAfter() does.
  
  Parameters:
  
  dottedKey - A dotted key (e.g. "server.address.port").
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If dottedKey is null.
  
  IllegalArgumentException - If the key cannot be parsed.
  
  NoSuchElementException - If the key is not set.
  
  TomlInvalidTypeException - If an element of the path preceding the final key is not a table.
- removeCommentAfter
  
  default MutableTomlTable removeCommentAfter(List<String> path)
  
  Remove the comment written on an entry's line, as MutableTomlEntry.removeCommentAfter() does.
  
  Parameters:
  
  path - The key path.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If a path element is null.
  
  IllegalArgumentException - If path is empty.
  
  NoSuchElementException - If the key is not set.
  
  TomlInvalidTypeException - If an element of the path preceding the final key is not a table.
- removeComment
  
  default MutableTomlTable removeComment(String dottedKey, TomlComment.Placement placement)
  
  Remove the attached comment at a placement, as MutableTomlEntry.removeComment(TomlComment.Placement) does.
  
  Parameters:
  
  dottedKey - A dotted key (e.g. "server.address.port").
  
  placement - Which attached comment to remove, TomlComment.Placement.ABOVE or TomlComment.Placement.AFTER.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If dottedKey, or placement, is null.
  
  IllegalArgumentException - If the key cannot be parsed, or placement is TomlComment.Placement.UNATTACHED.
  
  NoSuchElementException - If the key is not set.
  
  TomlInvalidTypeException - If an element of the path preceding the final key is not a table.
- removeComment
  
  default MutableTomlTable removeComment(List<String> path, TomlComment.Placement placement)
  
  Remove the attached comment at a placement, as MutableTomlEntry.removeComment(TomlComment.Placement) does.
  
  Parameters:
  
  path - The key path.
  
  placement - Which attached comment to remove, TomlComment.Placement.ABOVE or TomlComment.Placement.AFTER.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If a path element, or placement, is null.
  
  IllegalArgumentException - If path is empty, or placement is TomlComment.Placement.UNATTACHED.
  
  NoSuchElementException - If the key is not set.
  
  TomlInvalidTypeException - If an element of the path preceding the final key is not a table.
- addComment
  
  default MutableTomlTable addComment(String... lines)
  
  Add an unattached comment, after the elements already written, as addComment(List) does.
  
  Parameters:
  
  lines - The text of each line, as TomlComment.lines() would return it; a line holding a newline is split there.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If a line is null.
  
  IllegalArgumentException - If lines is empty, or a line cannot be written as a TOML comment.
- addComment
  
  default MutableTomlTable addComment(List<String> lines)
  
  Add an unattached comment, after the elements already written.
  
  Parameters:
  
  lines - The text of each line, as TomlComment.lines() would return it; a line holding a newline is split there.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If lines, or a line, is null.
  
  IllegalArgumentException - If lines is empty, or a line cannot be written as a TOML comment.
- addComment
  
  MutableTomlTable addComment(TomlComment comment)
  
  Add a comment, after the elements already written.
  The comment's position is ignored: the copy stored here has none. This is how an unattached comment is copied from one table or array to another, across documents too.
  
  Parameters:
  
  comment - The comment to add, with no placement.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If comment is null.
  
  IllegalArgumentException - If comment is attached.
- insertCommentBefore
  
  default MutableTomlTable insertCommentBefore(String anchorDottedKey, String... lines)
  
  Insert an unattached comment into this table before an existing entry, as insertCommentBefore(List, List) does.
  
  Parameters:
  
  anchorDottedKey - A dotted key naming the entry to insert beside (e.g. "server.address").
  
  lines - The text of each line, as TomlComment.lines() would return it; a line holding a newline is split there.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If anchorDottedKey, lines, or a line is null.
  
  IllegalArgumentException - If the anchor key cannot be parsed, lines is empty, or a line cannot be written as a TOML comment.
  
  NoSuchElementException - If the anchor is not set.
  
  TomlInvalidTypeException - If an element of the anchor path preceding the final key exists and is not a table.
- insertCommentBefore
  
  default MutableTomlTable insertCommentBefore(String anchorDottedKey, List<String> lines)
  
  Insert an unattached comment into this table before an existing entry, as insertCommentBefore(List, List) does.
  
  Parameters:
  
  anchorDottedKey - A dotted key naming the entry to insert beside (e.g. "server.address").
  
  lines - The text of each line, as TomlComment.lines() would return it; a line holding a newline is split there.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If anchorDottedKey, lines, or a line is null.
  
  IllegalArgumentException - If the anchor key cannot be parsed, lines is empty, or a line cannot be written as a TOML comment.
  
  NoSuchElementException - If the anchor is not set.
  
  TomlInvalidTypeException - If an element of the anchor path preceding the final key exists and is not a table.
- insertCommentBefore
  
  default MutableTomlTable insertCommentBefore(List<String> anchorPath, String... lines)
  
  Insert an unattached comment into this table before an existing entry, as insertCommentBefore(List, List) does.
  
  Parameters:
  
  anchorPath - The key path of the existing entry to insert beside.
  
  lines - The text of each line, as TomlComment.lines() would return it; a line holding a newline is split there.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If an element of anchorPath, lines, or a line is null.
  
  IllegalArgumentException - If anchorPath is empty, lines is empty, or a line cannot be written as a TOML comment.
  
  NoSuchElementException - If the anchor is not set.
  
  TomlInvalidTypeException - If an element of anchorPath preceding the final key exists and is not a table.
- insertCommentBefore
  
  default MutableTomlTable insertCommentBefore(List<String> anchorPath, List<String> lines)
  
  Insert an unattached comment into this table before an existing entry, as insertCommentBefore(List, TomlComment) places one.
  
  Parameters:
  
  anchorPath - The key path of the existing entry to insert beside.
  
  lines - The text of each line, as TomlComment.lines() would return it; a line holding a newline is split there.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If an element of anchorPath, lines, or a line is null.
  
  IllegalArgumentException - If anchorPath is empty, lines is empty, or a line cannot be written as a TOML comment.
  
  NoSuchElementException - If the anchor is not set.
  
  TomlInvalidTypeException - If an element of anchorPath preceding the final key exists and is not a table.
- insertCommentBefore
  
  default MutableTomlTable insertCommentBefore(String anchorDottedKey, TomlComment comment)
  
  Insert a comment into this table before an existing entry, as insertCommentBefore(List, TomlComment) does.
  
  Parameters:
  
  anchorDottedKey - A dotted key naming the entry to insert beside (e.g. "server.address").
  
  comment - The comment to insert, with no placement.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If anchorDottedKey, or comment, is null.
  
  IllegalArgumentException - If the anchor key cannot be parsed, or comment is attached.
  
  NoSuchElementException - If the anchor is not set.
  
  TomlInvalidTypeException - If an element of the anchor path preceding the final key exists and is not a table.
- insertCommentBefore
  
  MutableTomlTable insertCommentBefore(List<String> anchorPath, TomlComment comment)
  
  Insert a comment into this table before an existing entry.
  The comment is inserted as addComment(TomlComment) adds one, its position ignored, immediately before the anchor entry. The anchor's own TomlComment.Placement.ABOVE run stays attached to it, so the new comment is written above that run.
  
  Parameters:
  
  anchorPath - The key path of the existing entry to insert beside.
  
  comment - The comment to insert, with no placement.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If an element of anchorPath, or comment, is null.
  
  IllegalArgumentException - If anchorPath is empty, or comment is attached.
  
  NoSuchElementException - If the anchor is not set.
  
  TomlInvalidTypeException - If an element of anchorPath preceding the final key exists and is not a table.
- insertCommentAfter
  
  default MutableTomlTable insertCommentAfter(String anchorDottedKey, String... lines)
  
  Insert an unattached comment into this table after an existing entry, as insertCommentAfter(List, List) does.
  
  Parameters:
  
  anchorDottedKey - A dotted key naming the entry to insert beside (e.g. "server.address").
  
  lines - The text of each line, as TomlComment.lines() would return it; a line holding a newline is split there.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If anchorDottedKey, lines, or a line is null.
  
  IllegalArgumentException - If the anchor key cannot be parsed, lines is empty, or a line cannot be written as a TOML comment.
  
  NoSuchElementException - If the anchor is not set.
  
  TomlInvalidTypeException - If an element of the anchor path preceding the final key exists and is not a table.
- insertCommentAfter
  
  default MutableTomlTable insertCommentAfter(String anchorDottedKey, List<String> lines)
  
  Insert an unattached comment into this table after an existing entry, as insertCommentAfter(List, List) does.
  
  Parameters:
  
  anchorDottedKey - A dotted key naming the entry to insert beside (e.g. "server.address").
  
  lines - The text of each line, as TomlComment.lines() would return it; a line holding a newline is split there.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If anchorDottedKey, lines, or a line is null.
  
  IllegalArgumentException - If the anchor key cannot be parsed, lines is empty, or a line cannot be written as a TOML comment.
  
  NoSuchElementException - If the anchor is not set.
  
  TomlInvalidTypeException - If an element of the anchor path preceding the final key exists and is not a table.
- insertCommentAfter
  
  default MutableTomlTable insertCommentAfter(List<String> anchorPath, String... lines)
  
  Insert an unattached comment into this table after an existing entry, as insertCommentAfter(List, List) does.
  
  Parameters:
  
  anchorPath - The key path of the existing entry to insert beside.
  
  lines - The text of each line, as TomlComment.lines() would return it; a line holding a newline is split there.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If an element of anchorPath, lines, or a line is null.
  
  IllegalArgumentException - If anchorPath is empty, lines is empty, or a line cannot be written as a TOML comment.
  
  NoSuchElementException - If the anchor is not set.
  
  TomlInvalidTypeException - If an element of anchorPath preceding the final key exists and is not a table.
- insertCommentAfter
  
  default MutableTomlTable insertCommentAfter(List<String> anchorPath, List<String> lines)
  
  Insert an unattached comment into this table after an existing entry, as insertCommentAfter(List, TomlComment) places one.
  
  Parameters:
  
  anchorPath - The key path of the existing entry to insert beside.
  
  lines - The text of each line, as TomlComment.lines() would return it; a line holding a newline is split there.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If an element of anchorPath, lines, or a line is null.
  
  IllegalArgumentException - If anchorPath is empty, lines is empty, or a line cannot be written as a TOML comment.
  
  NoSuchElementException - If the anchor is not set.
  
  TomlInvalidTypeException - If an element of anchorPath preceding the final key exists and is not a table.
- insertCommentAfter
  
  default MutableTomlTable insertCommentAfter(String anchorDottedKey, TomlComment comment)
  
  Insert a comment into this table after an existing entry, as insertCommentAfter(List, TomlComment) does.
  
  Parameters:
  
  anchorDottedKey - A dotted key naming the entry to insert beside (e.g. "server.address").
  
  comment - The comment to insert, with no placement.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If anchorDottedKey, or comment, is null.
  
  IllegalArgumentException - If the anchor key cannot be parsed, or comment is attached.
  
  NoSuchElementException - If the anchor is not set.
  
  TomlInvalidTypeException - If an element of the anchor path preceding the final key exists and is not a table.
- insertCommentAfter
  
  MutableTomlTable insertCommentAfter(List<String> anchorPath, TomlComment comment)
  
  Insert a comment into this table after an existing entry.
  The comment is inserted as addComment(TomlComment) adds one, its position ignored, immediately after the anchor entry in this table's TomlTable.elements().
  
  Parameters:
  
  anchorPath - The key path of the existing entry to insert beside.
  
  comment - The comment to insert, with no placement.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If an element of anchorPath, or comment, is null.
  
  IllegalArgumentException - If anchorPath is empty, or comment is attached.
  
  NoSuchElementException - If the anchor is not set.
  
  TomlInvalidTypeException - If an element of anchorPath preceding the final key exists and is not a table.
- insertCommentBefore
  
  default MutableTomlTable insertCommentBefore(TomlElement anchor, String... lines)
  
  Insert an unattached comment into this table immediately before an element of its sequence, as insertCommentBefore(TomlElement, List) does.
  
  Parameters:
  
  anchor - The element to insert before.
  
  lines - The text of each line, as TomlComment.lines() would return it; a line holding a newline is split there.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If anchor, lines, or a line is null.
  
  IllegalArgumentException - If lines is empty, or a line cannot be written as a TOML comment.
  
  NoSuchElementException - If anchor is not an element of this table's TomlTable.elements().
- insertCommentBefore
  
  default MutableTomlTable insertCommentBefore(TomlElement anchor, List<String> lines)
  
  Insert an unattached comment into this table immediately before an element of its sequence, as insertCommentBefore(TomlElement, TomlComment) places one.
  
  Parameters:
  
  anchor - The element to insert before.
  
  lines - The text of each line, as TomlComment.lines() would return it; a line holding a newline is split there.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If anchor, lines, or a line is null.
  
  IllegalArgumentException - If lines is empty, or a line cannot be written as a TOML comment.
  
  NoSuchElementException - If anchor is not an element of this table's TomlTable.elements().
- insertCommentBefore
  
  MutableTomlTable insertCommentBefore(TomlElement anchor, TomlComment comment)
  
  Insert a comment into this table immediately before an element of its sequence.
  The comment is inserted as addComment(TomlComment) adds one, its position ignored. The anchor is an element of this table's own TomlTable.elements(), matched by identity: an element of a sub-table, a copy, or another document is rejected, even if it is equal. It may be an entry or an unattached comment; "before an entry" means before the entry itself, so its own attached comments stay attached to it.
  
  Parameters:
  
  anchor - The element to insert before.
  
  comment - The comment to insert, with no placement.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If anchor or comment is null.
  
  IllegalArgumentException - If comment is attached.
  
  NoSuchElementException - If anchor is not an element of this table's TomlTable.elements().
- insertCommentAfter
  
  default MutableTomlTable insertCommentAfter(TomlElement anchor, String... lines)
  
  Insert an unattached comment into this table immediately after an element of its sequence, as insertCommentAfter(TomlElement, List) does.
  
  Parameters:
  
  anchor - The element to insert after.
  
  lines - The text of each line, as TomlComment.lines() would return it; a line holding a newline is split there.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If anchor, lines, or a line is null.
  
  IllegalArgumentException - If lines is empty, or a line cannot be written as a TOML comment.
  
  NoSuchElementException - If anchor is not an element of this table's TomlTable.elements().
- insertCommentAfter
  
  default MutableTomlTable insertCommentAfter(TomlElement anchor, List<String> lines)
  
  Insert an unattached comment into this table immediately after an element of its sequence, as insertCommentAfter(TomlElement, TomlComment) places one.
  
  Parameters:
  
  anchor - The element to insert after.
  
  lines - The text of each line, as TomlComment.lines() would return it; a line holding a newline is split there.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If anchor, lines, or a line is null.
  
  IllegalArgumentException - If lines is empty, or a line cannot be written as a TOML comment.
  
  NoSuchElementException - If anchor is not an element of this table's TomlTable.elements().
- insertCommentAfter
  
  MutableTomlTable insertCommentAfter(TomlElement anchor, TomlComment comment)
  
  Insert a comment into this table immediately after an element of its sequence.
  The comment is inserted as addComment(TomlComment) adds one, its position ignored, immediately after anchor, matched as insertCommentBefore(TomlElement, TomlComment) matches one.
  
  Parameters:
  
  anchor - The element to insert after.
  
  comment - The comment to insert, with no placement.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If anchor or comment is null.
  
  IllegalArgumentException - If comment is attached.
  
  NoSuchElementException - If anchor is not an element of this table's TomlTable.elements().
- removeComment
  
  boolean removeComment(TomlComment comment)
  
  Remove an unattached comment, by identity.
  
  Parameters:
  
  comment - The comment to remove.
  
  Returns:
  
  true if comment was among this table's TomlTable.elements(), and was removed. An attached comment is never among them, so removing one here always returns false.
- reformat
  
  MutableTomlTable reformat(TomlWriteOptions.Keep keep)
  Keep less of the existing structure and format of this table, and of everything in it.
  A parse result is written from the text it was parsed from, so a table keeps its layout until it is changed. Reformatting it discards that:
  
  With TomlWriteOptions.Keep.LAYOUT, which every table starts with, nothing changes.
  
  With TomlWriteOptions.Keep.NOTATION its lines keep their order, comments, literal forms and structure, whether a header, dotted keys or an inline table, and take the layout the options give.
  
  With TomlWriteOptions.Keep.NOTHING it is written entirely in the default style, as a table built with the editing API is, in the place its header had.
  
  The amount to keep applies to every table and array nested in this one. A later call keeps the lesser of the two amounts, so a call asking for more than was set changes nothing and a reformat cannot be undone. A copy of this table is reformatted the same way.
  Parameters:
  
  keep - How much of the existing structure and format of this table to keep.
  
  Returns:
  
  This table.
  
  Throws:
  
  NullPointerException - If keep is null.
- copyOf
  
  static MutableTomlTable copyOf(TomlTable table)
  
  Create a deep copy of a table.
  The copy is independent of table: a nested table or array is copied recursively, and later changes to either are not seen by the other. Every entry of the copy has no input position and reports as modified, since none of it was read from a document; the copy itself reports isModified() false while it has no entries, like create(). The comments attached to each entry, and the unattached comments among the table's elements, are kept.
  
  Parameters:
  
  table - The table to copy.
  
  Returns:
  
  A new, independent table with the same entries.
  
  Throws:
  
  IllegalArgumentException - If a key in table contains an unpaired surrogate, or a value in it cannot be written as TOML.
- copyOf
  
  static MutableTomlTable copyOf(Map<String,?> map)
  
  Create a table from a Map.
  Each key of map is one literal key, not a dotted key. Each value is converted as any value set through this interface is.
  
  Parameters:
  
  map - The map to copy.
  
  Returns:
  
  A new table with one entry per entry of map.
  
  Throws:
  
  NullPointerException - If a value in map is null.
  
  IllegalArgumentException - If a key in map contains an unpaired surrogate, or a value in it cannot be converted to a TOML value or cannot be written as TOML.
- entry
  
  default @Nullable MutableTomlKeyValue entry(String dottedKey)
  
  Description copied from interface: TomlTable
  
  Get the entry for a key.
  The key is parsed using TOML key syntax, so keys containing characters other than A-Z, a-z, 0-9, _ and - must be quoted (e.g. "\"@key\""). To look up a raw key name without quoting, such as one returned by TomlTable.keySet(), use TomlTable.entry(List) instead.
  
  Specified by:
  
  entry in interface TomlTable
  
  Parameters:
  
  dottedKey - A dotted key (e.g. "server.address.port").
  
  Returns:
  
  The entry, or null if the key was not set in the TOML document.
- entry
  
  @Nullable MutableTomlKeyValue entry(List<String> path)
  
  Description copied from interface: TomlTable
  
  Get the entry for a key.
  The entry is the TomlKeyValue that TomlTable.elements() holds for the key, in the table the path leads to. TomlTable.get(List), TomlTable.inputPositionOf(List) and TomlTable.comments(List) are shortcuts that read the value, position and comments of this entry. An empty path names this table itself, which is not an entry, so it returns null.
  
  Specified by:
  
  entry in interface TomlTable
  
  Parameters:
  
  path - The key path.
  
  Returns:
  
  The entry, or null if the key was not set in the TOML document.
- getTable
  
  default @Nullable MutableTomlTable getTable(String dottedKey)
  
  Description copied from interface: TomlTable
  
  Get a table from the TOML document.
  
  Specified by:
  
  getTable in interface TomlTable
  
  Parameters:
  
  dottedKey - A dotted key (e.g. "server.address").
  
  Returns:
  
  The value, or null if no value was set in the TOML document.
- getTable
  
  default @Nullable MutableTomlTable getTable(List<String> path)
  
  Description copied from interface: TomlTable
  
  Get a table from the TOML document.
  
  Specified by:
  
  getTable in interface TomlTable
  
  Parameters:
  
  path - The key path.
  
  Returns:
  
  The value, or null if no value was set in the TOML document.
- getArray
  
  default @Nullable MutableTomlArray getArray(String dottedKey)
  
  Description copied from interface: TomlTable
  
  Get an array from the TOML document.
  
  Specified by:
  
  getArray in interface TomlTable
  
  Parameters:
  
  dottedKey - A dotted key (e.g. "server.addresses").
  
  Returns:
  
  The value, or null if no value was set in the TOML document.
- getArray
  
  default @Nullable MutableTomlArray getArray(List<String> path)
  
  Description copied from interface: TomlTable
  
  Get an array from the TOML document.
  
  Specified by:
  
  getArray in interface TomlTable
  
  Parameters:
  
  path - The key path.
  
  Returns:
  
  The value, or null if no value was set in the TOML document.

Interface MutableTomlTable

Method Summary

Methods inherited from interface org.tomlj.TomlTable

Method Details

create

createInline

getOrCreateTable

getOrCreateTable

getOrCreateArray

getOrCreateArray

set

set

insertBefore

insertBefore

insertAfter

insertAfter

insertBefore

insertAfter

remove

remove

clear

isModified

isModified

isModified

setCommentAbove

setCommentAbove

setCommentAbove

setCommentAbove

setCommentAfter

setCommentAfter

setComment

setComment

setComment

setComment

removeCommentAbove

removeCommentAbove

removeCommentAfter

removeCommentAfter

removeComment

removeComment

addComment

addComment

addComment

insertCommentBefore

insertCommentBefore

insertCommentBefore

insertCommentBefore

insertCommentBefore

insertCommentBefore

insertCommentAfter

insertCommentAfter

insertCommentAfter

insertCommentAfter

insertCommentAfter

insertCommentAfter

insertCommentBefore

insertCommentBefore

insertCommentBefore

insertCommentAfter

insertCommentAfter

insertCommentAfter

removeComment

reformat

copyOf

copyOf

entry

entry

getTable

getTable

getArray

getArray