Package org.tomlj

Interface MutableTomlArray

All Superinterfaces:

TomlArray

public interface MutableTomlArray
extends TomlArray

A TomlArray whose values can be edited in place.

Accepts the values MutableTomlTable accepts, converted the same way. 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. null throws a NullPointerException.

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.

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

An array read from [[x]] headers accepts any value; nothing requires its entries to stay tables.

An array is written back out with TomlArray.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
MutableTomlArray	add(Object value)	Append a value to this array.
default MutableTomlArray	addComment(String... lines)	Add an unattached comment, after the elements already written, as addComment(List) does.
default MutableTomlArray	addComment(List<String> lines)	Add an unattached comment, after the elements already written.
MutableTomlArray	addComment(TomlComment comment)	Add a comment, after the elements already written.
void	clear()	Remove every entry from this array.
static MutableTomlArray	copyOf(Iterable<?> values)	Create an array from an Iterable.
static MutableTomlArray	copyOf(TomlArray array)	Create a deep copy of an array.
static MutableTomlArray	create()	Create a new, empty array.
static MutableTomlArray	createInline()	Create a new, empty array to be written between brackets.
MutableTomlEntry	entry(int index)	Get the entry at an index.
default MutableTomlArray	getArray(int index)	Get an array at a specified index.
default MutableTomlTable	getTable(int index)	Get a table at a specified index.
MutableTomlArray	insertAfter(int index, Object value)	Insert a value into this array immediately after the entry at an index.
MutableTomlArray	insertAfter(TomlElement anchor, Object value)	Insert a value into this array immediately after an element of its sequence.
MutableTomlArray	insertBefore(int index, Object value)	Insert a value into this array immediately before the entry at an index.
MutableTomlArray	insertBefore(TomlElement anchor, Object value)	Insert a value into this array immediately before an element of its sequence.
default MutableTomlArray	insertCommentAfter(int index, String... lines)	Insert an unattached comment into this array immediately after the entry at an index, as insertCommentAfter(int, List) does.
default MutableTomlArray	insertCommentAfter(int index, List<String> lines)	Insert an unattached comment into this array immediately after the entry at an index, as insertCommentAfter(int, TomlComment) places one.
MutableTomlArray	insertCommentAfter(int index, TomlComment comment)	Insert a comment into this array immediately after the entry at an index.
default MutableTomlArray	insertCommentAfter(TomlElement anchor, String... lines)	Insert an unattached comment into this array immediately after an element of its sequence, as insertCommentAfter(TomlElement, List) does.
default MutableTomlArray	insertCommentAfter(TomlElement anchor, List<String> lines)	Insert an unattached comment into this array immediately after an element of its sequence, as insertCommentAfter(TomlElement, TomlComment) places one.
MutableTomlArray	insertCommentAfter(TomlElement anchor, TomlComment comment)	Insert a comment into this array immediately after an element of its sequence.
default MutableTomlArray	insertCommentBefore(int index, String... lines)	Insert an unattached comment into this array immediately before the entry at an index, as insertCommentBefore(int, List) does.
default MutableTomlArray	insertCommentBefore(int index, List<String> lines)	Insert an unattached comment into this array immediately before the entry at an index, as insertCommentBefore(int, TomlComment) places one.
MutableTomlArray	insertCommentBefore(int index, TomlComment comment)	Insert a comment into this array immediately before the entry at an index.
default MutableTomlArray	insertCommentBefore(TomlElement anchor, String... lines)	Insert an unattached comment into this array immediately before an element of its sequence, as insertCommentBefore(TomlElement, List) does.
default MutableTomlArray	insertCommentBefore(TomlElement anchor, List<String> lines)	Insert an unattached comment into this array immediately before an element of its sequence, as insertCommentBefore(TomlElement, TomlComment) places one.
MutableTomlArray	insertCommentBefore(TomlElement anchor, TomlComment comment)	Insert a comment into this array immediately before an element of its sequence.
boolean	isModified()	Whether this array was changed through this interface.
boolean	isModified(int index)	Whether an entry of this array was changed through this interface.
static MutableTomlArray	of(Object... values)	Create an array from a sequence of values.
MutableTomlArray	reformat(TomlWriteOptions.Keep keep)	Keep less of the existing structure and format of this array, and of everything in it.
Object	remove(int index)	Remove the value at an index.
default MutableTomlArray	removeComment(int index, 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 MutableTomlArray	removeCommentAbove(int index)	Remove the run of comment lines written above an entry, as MutableTomlEntry.removeCommentAbove() does.
default MutableTomlArray	removeCommentAfter(int index)	Remove the comment written on an entry's line, as MutableTomlEntry.removeCommentAfter() does.
MutableTomlArray	set(int index, Object value)	Replace the value at an index.
default MutableTomlArray	setComment(int index, String text, TomlComment.Placement placement)	Set an attached comment on an entry from its text, as MutableTomlEntry.setComment(String, TomlComment.Placement) does.
default MutableTomlArray	setComment(int index, TomlComment comment)	Set an attached comment on an entry, as MutableTomlEntry.setComment(TomlComment) does.
default MutableTomlArray	setCommentAbove(int index, String... lines)	Set the run of comment lines written above an entry, as MutableTomlEntry.setCommentAbove(String...) does.
default MutableTomlArray	setCommentAbove(int index, List<String> lines)	Set the run of comment lines written above an entry, as MutableTomlEntry.setCommentAbove(List) does.
default MutableTomlArray	setCommentAfter(int index, String text)	Set the comment written on an entry's line, as MutableTomlEntry.setCommentAfter(String) does.

Methods inherited from interface org.tomlj.TomlArray

comment, comments, elements, get, getBoolean, getDouble, getLocalDate, getLocalDateTime, getLocalTime, getLong, getOffsetDateTime, getString, inputPositionOf, isArray, isBoolean, isDouble, isEmpty, isLocalDate, isLocalDateTime, isLocalTime, isLong, isOffsetDateTime, isString, isTable, size, toJson, toJson, toJson, toJson, toList, toToml, toToml, toToml, toToml

Method Details

create

static MutableTomlArray create()

Create a new, empty array.

Returns:

A new, empty array.

createInline

static MutableTomlArray createInline()

Create a new, empty array to be written between brackets.

The array is written between brackets on the line of the entry holding it, as a = [{ x = 1 }], whatever it holds, unless the document is written keeping nothing (TomlWriteOptions.Keep.NOTHING). An array made with create() whose elements are all tables is written as [[a]] headers instead.

Returns:

A new, empty array.

of

static MutableTomlArray of(Object... values)

Create an array from a sequence of values.

Parameters:

values - The values, each converted as add(Object) converts one.

Returns:

A new array with one entry per value.

Throws:

NullPointerException - If a value is null.

IllegalArgumentException - If a value cannot be converted to a TOML value, or cannot be written as TOML.

add

MutableTomlArray add(Object value)

Append a value to this array.

The new entry has no position and no comments. A table or array is stored as a deep copy, made as copyOf(TomlArray) makes one, so it has no positions.

Parameters:

value - The value to add.

Returns:

This array.

Throws:

NullPointerException - If value is null.

IllegalArgumentException - If value cannot be converted to a TOML value, or cannot be written as TOML.

insertBefore

MutableTomlArray insertBefore(int index,
 Object value)

Insert a value into this array immediately before the entry at an index.

The new entry goes immediately before the entry at index in this array's TomlArray.elements(), so an unattached comment beside that entry stays on its own side. The new entry has no position and no comments, and value is converted as add(Object) converts one. A table or array is stored as a deep copy, made as copyOf(TomlArray) makes one, so it has no positions.

Parameters:

index - The array index of the entry to insert before.

value - The value to insert.

Returns:

This array.

Throws:

IndexOutOfBoundsException - If index is negative or not less than TomlArray.size().

NullPointerException - If value is null.

IllegalArgumentException - If value cannot be converted to a TOML value, or cannot be written as TOML.

insertAfter

MutableTomlArray insertAfter(int index,
 Object value)

Insert a value into this array immediately after the entry at an index.

The new entry goes immediately after the entry at index in this array's TomlArray.elements(), so an unattached comment beside that entry stays on its own side. insertAfter(size() - 1, value) differs from add(Object): it places the new entry immediately after the last entry, before any unattached comments that follow it, while add appends after the last element. The new entry has no position and no comments, and value is converted as add(Object) converts one. A table or array is stored as a deep copy, made as copyOf(TomlArray) makes one, so it has no positions.

Parameters:

index - The array index of the entry to insert after.

value - The value to insert.

Returns:

This array.

Throws:

IndexOutOfBoundsException - If index is negative or not less than TomlArray.size().

NullPointerException - If value is null.

IllegalArgumentException - If value cannot be converted to a TOML value, or cannot be written as TOML.

insertBefore

MutableTomlArray insertBefore(TomlElement anchor,
 Object value)

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

The anchor is an element of this array's own TomlArray.elements(), matched by identity: an element of a sub-array, 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 comments, and value is converted as add(Object) converts one. A table or array is stored as a deep copy, made as copyOf(TomlArray) makes one, so it has no positions.

Parameters:

anchor - The element to insert before.

value - The value to insert.

Returns:

This array.

Throws:

NullPointerException - If anchor or value is null.

IllegalArgumentException - If value cannot be converted to a TOML value, or cannot be written as TOML.

NoSuchElementException - If anchor is not an element of this array's TomlArray.elements().

insertAfter

MutableTomlArray insertAfter(TomlElement anchor,
 Object value)

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

The new entry is placed immediately after anchor, matched as insertBefore(TomlElement, Object) matches one. The new entry has no position and no comments, and value is converted as add(Object) converts one. A table or array is stored as a deep copy, made as copyOf(TomlArray) makes one, so it has no positions.

Parameters:

anchor - The element to insert after.

value - The value to insert.

Returns:

This array.

Throws:

NullPointerException - If anchor or value is null.

IllegalArgumentException - If value cannot be converted to a TOML value, or cannot be written as TOML.

NoSuchElementException - If anchor is not an element of this array's TomlArray.elements().

set

MutableTomlArray set(int index,
 Object value)

Replace the value at an index.

The entry keeps its place in the array and its attached comments. Its position is its value's, and a value set here has none, so TomlArray.inputPositionOf(int) is null for the index afterwards. A table or array is stored as a deep copy, made as copyOf(TomlArray) makes one.

Parameters:

index - The array index.

value - The replacement value.

Returns:

This array.

Throws:

IndexOutOfBoundsException - If the index is out of bounds.

NullPointerException - If value is null.

IllegalArgumentException - If value cannot be converted to a TOML value, or cannot be written as TOML.

remove

Object remove(int index)

Remove the value at an index.

The entry is removed, with the comments attached to it, and every later entry moves down by one. The unattached comments among this array's elements stay where they are.

Parameters:

index - The array index.

Returns:

The value that was removed.

Throws:

IndexOutOfBoundsException - If the index is out of bounds.

clear

void clear()

Remove every entry from this array.

The unattached comments among this array's elements stay where they are. Clearing an array that is already empty is not a modification.

isModified

boolean isModified()

Whether this array was changed through this interface.

A change is an entry added, replaced or removed, in this array or in any table or array nested within it. An array read from a document, or newly created, reports false; nothing resets this once it is true.

Returns:

true if this array was changed through this interface.

isModified

boolean isModified(int index)

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

A change is the entry added or replaced, or a change within the table or array it holds.

Parameters:

index - The array index.

Returns:

true if the entry was changed.

Throws:

IndexOutOfBoundsException - If the index is out of bounds.

setCommentAbove

default MutableTomlArray setCommentAbove(int index,
 String... lines)

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

Parameters:

index - The array index.

lines - The text of each line, as TomlComment.lines() would return it; a line holding a newline is split there.

Returns:

This array.

Throws:

IndexOutOfBoundsException - If the index is out of bounds.

NullPointerException - If a line is null.

IllegalArgumentException - If lines is empty, or a line cannot be written as a TOML comment.

setCommentAbove

default MutableTomlArray setCommentAbove(int index,
 List<String> lines)

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

Parameters:

index - The array index.

lines - The text of each line, as TomlComment.lines() would return it; a line holding a newline is split there.

Returns:

This array.

Throws:

IndexOutOfBoundsException - If the index is out of bounds.

NullPointerException - If lines, or a line, is null.

IllegalArgumentException - If lines is empty, or a line cannot be written as a TOML comment.

setCommentAfter

default MutableTomlArray setCommentAfter(int index,
 String text)

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

Parameters:

index - The array index.

text - The comment text, as TomlComment.lines() would return its one line.

Returns:

This array.

Throws:

IndexOutOfBoundsException - If the index is out of bounds.

NullPointerException - If text is null.

IllegalArgumentException - If text cannot be written as a TOML comment.

setComment

default MutableTomlArray setComment(int index,
 String text,
 TomlComment.Placement placement)

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

Parameters:

index - The array index.

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 array.

Throws:

IndexOutOfBoundsException - If the index is out of bounds.

NullPointerException - If text or placement is null.

IllegalArgumentException - If placement is TomlComment.Placement.UNATTACHED, or a line of text cannot be written as a TOML comment.

setComment

default MutableTomlArray setComment(int index,
 TomlComment comment)

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

Parameters:

index - The array index.

comment - The comment, with TomlComment.placement() either TomlComment.Placement.ABOVE or TomlComment.Placement.AFTER.

Returns:

This array.

Throws:

IndexOutOfBoundsException - If the index is out of bounds.

NullPointerException - If comment is null.

IllegalArgumentException - If comment is unattached.

removeCommentAbove

default MutableTomlArray removeCommentAbove(int index)

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

Parameters:

index - The array index.

Returns:

This array.

Throws:

IndexOutOfBoundsException - If the index is out of bounds.

removeCommentAfter

default MutableTomlArray removeCommentAfter(int index)

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

Parameters:

index - The array index.

Returns:

This array.

Throws:

IndexOutOfBoundsException - If the index is out of bounds.

removeComment

default MutableTomlArray removeComment(int index,
 TomlComment.Placement placement)

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

Parameters:

index - The array index.

placement - Which attached comment to remove, TomlComment.Placement.ABOVE or TomlComment.Placement.AFTER.

Returns:

This array.

Throws:

IndexOutOfBoundsException - If the index is out of bounds.

NullPointerException - If placement is null.

IllegalArgumentException - If placement is TomlComment.Placement.UNATTACHED.

addComment

default MutableTomlArray 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 array.

Throws:

NullPointerException - If a line is null.

IllegalArgumentException - If lines is empty, or a line cannot be written as a TOML comment.

addComment

default MutableTomlArray 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 array.

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

MutableTomlArray 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 array.

Throws:

NullPointerException - If comment is null.

IllegalArgumentException - If comment is attached.

insertCommentBefore

default MutableTomlArray insertCommentBefore(int index,
 String... lines)

Insert an unattached comment into this array immediately before the entry at an index, as insertCommentBefore(int, List) does.

Parameters:

index - The array index of the entry 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 array.

Throws:

IndexOutOfBoundsException - If index is negative or not less than TomlArray.size().

NullPointerException - If a line is null.

IllegalArgumentException - If lines is empty, or a line cannot be written as a TOML comment.

insertCommentBefore

default MutableTomlArray insertCommentBefore(int index,
 List<String> lines)

Insert an unattached comment into this array immediately before the entry at an index, as insertCommentBefore(int, TomlComment) places one.

Parameters:

index - The array index of the entry 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 array.

Throws:

IndexOutOfBoundsException - If index is negative or not less than TomlArray.size().

NullPointerException - If lines, or a line, is null.

IllegalArgumentException - If lines is empty, or a line cannot be written as a TOML comment.

insertCommentBefore

MutableTomlArray insertCommentBefore(int index,
 TomlComment comment)

Insert a comment into this array immediately before the entry at an index.

The comment is inserted as addComment(TomlComment) adds one, its position ignored, immediately before the entry at index, as insertBefore(int, Object) places a value.

Parameters:

index - The array index of the entry to insert before.

comment - The comment to insert, with no placement.

Returns:

This array.

Throws:

IndexOutOfBoundsException - If index is negative or not less than TomlArray.size().

NullPointerException - If comment is null.

IllegalArgumentException - If comment is attached.

insertCommentAfter

default MutableTomlArray insertCommentAfter(int index,
 String... lines)

Insert an unattached comment into this array immediately after the entry at an index, as insertCommentAfter(int, List) does.

Parameters:

index - The array index of the entry 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 array.

Throws:

IndexOutOfBoundsException - If index is negative or not less than TomlArray.size().

NullPointerException - If a line is null.

IllegalArgumentException - If lines is empty, or a line cannot be written as a TOML comment.

insertCommentAfter

default MutableTomlArray insertCommentAfter(int index,
 List<String> lines)

Insert an unattached comment into this array immediately after the entry at an index, as insertCommentAfter(int, TomlComment) places one.

Parameters:

index - The array index of the entry 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 array.

Throws:

IndexOutOfBoundsException - If index is negative or not less than TomlArray.size().

NullPointerException - If lines, or a line, is null.

IllegalArgumentException - If lines is empty, or a line cannot be written as a TOML comment.

insertCommentAfter

MutableTomlArray insertCommentAfter(int index,
 TomlComment comment)

Insert a comment into this array immediately after the entry at an index.

The comment is inserted as addComment(TomlComment) adds one, its position ignored, immediately after the entry at index, as insertAfter(int, Object) places a value.

Parameters:

index - The array index of the entry to insert after.

comment - The comment to insert, with no placement.

Returns:

This array.

Throws:

IndexOutOfBoundsException - If index is negative or not less than TomlArray.size().

NullPointerException - If comment is null.

IllegalArgumentException - If comment is attached.

insertCommentBefore

default MutableTomlArray insertCommentBefore(TomlElement anchor,
 String... lines)

Insert an unattached comment into this array 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 array.

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 array's TomlArray.elements().

insertCommentBefore

default MutableTomlArray insertCommentBefore(TomlElement anchor,
 List<String> lines)

Insert an unattached comment into this array 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 array.

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 array's TomlArray.elements().

insertCommentBefore

MutableTomlArray insertCommentBefore(TomlElement anchor,
 TomlComment comment)

Insert a comment into this array 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 array's own TomlArray.elements(), matched by identity: an element of a sub-array, 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 array.

Throws:

NullPointerException - If anchor or comment is null.

IllegalArgumentException - If comment is attached.

NoSuchElementException - If anchor is not an element of this array's TomlArray.elements().

insertCommentAfter

default MutableTomlArray insertCommentAfter(TomlElement anchor,
 String... lines)

Insert an unattached comment into this array 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 array.

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 array's TomlArray.elements().

insertCommentAfter

default MutableTomlArray insertCommentAfter(TomlElement anchor,
 List<String> lines)

Insert an unattached comment into this array 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 array.

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 array's TomlArray.elements().

insertCommentAfter

MutableTomlArray insertCommentAfter(TomlElement anchor,
 TomlComment comment)

Insert a comment into this array 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 array.

Throws:

NullPointerException - If anchor or comment is null.

IllegalArgumentException - If comment is attached.

NoSuchElementException - If anchor is not an element of this array's TomlArray.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 array's TomlArray.elements(), and was removed. An attached comment is never among them, so removing one here always returns false.

reformat

MutableTomlArray reformat(TomlWriteOptions.Keep keep)

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

A parse result is written from the text it was parsed from, so an array keeps its layout until it is changed. Reformatting it discards that:

• With TomlWriteOptions.Keep.LAYOUT, which every array starts with, nothing changes.
• With TomlWriteOptions.Keep.NOTATION its elements keep their order, comments, literal forms and the structure of the tables among them, and take the layout the options give.
• With TomlWriteOptions.Keep.NOTHING it is written entirely in the default style, as an array built with the editing API is.

An array of the tables of [[header]] sections is written as those sections, keeping that amount, in the place the first of them had; any other array is written anew on the line it is written on. 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 array is reformatted the same way.

Parameters:

keep - How much of the existing structure and format of this array to keep.

Returns:

This array.

Throws:

NullPointerException - If keep is null.

copyOf

static MutableTomlArray copyOf(TomlArray array)

Create a deep copy of an array.

The copy is independent of array: 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 array's elements, are kept.

Parameters:

array - The array to copy.

Returns:

A new, independent array with the same entries.

Throws:

IllegalArgumentException - If a value in array cannot be written as TOML.

copyOf

static MutableTomlArray copyOf(Iterable<?> values)

Create an array from an Iterable.

Any Iterable is accepted here, not only a Collection as when one is set as a value: an Iterable that is not a Collection is rejected as a value, and is converted to an array by passing it here.

Parameters:

values - The values, each converted as add(Object) converts one.

Returns:

A new array with one entry per value.

Throws:

NullPointerException - If a value is null.

IllegalArgumentException - If a value cannot be converted to a TOML value, or cannot be written as TOML.

entry

MutableTomlEntry entry(int index)

Description copied from interface: TomlArray

Get the entry at an index.

The entry is the TomlEntry that TomlArray.elements() holds for the index. TomlArray.get(int), TomlArray.inputPositionOf(int) and TomlArray.comments(int) are shortcuts reading its value, position and comments.

Specified by:

entry in interface TomlArray

Parameters:

index - The array index.

Returns:

The entry.

getTable

default MutableTomlTable getTable(int index)

Description copied from interface: TomlArray

Get a table at a specified index.

Specified by:

getTable in interface TomlArray

Parameters:

index - The array index.

Returns:

The value.

getArray

default MutableTomlArray getArray(int index)

Description copied from interface: TomlArray

Get an array at a specified index.

Specified by:

getArray in interface TomlArray

Parameters:

index - The array index.

Returns:

The value.