Class MutableTomlTable

java.lang.Object

org.tomlj.MutableTomlTable

All Implemented Interfaces:

TomlTable

final class MutableTomlTable
extends Object
implements TomlTable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	MutableTomlTable.Element
private static class	MutableTomlTable.EnsureTableResult

Field Summary

Fields

Modifier and Type	Field	Description
private TomlPosition	definedAt
private final Map<String, MutableTomlTable.Element>	properties
private final TomlVersion	version

Constructor Summary

Constructors

Constructor	Description
MutableTomlTable(TomlVersion version)
MutableTomlTable(TomlVersion version, TomlPosition definedAt)

Method Summary

Modifier and Type	Method	Description
(package private) MutableTomlTable	createTable(List<String> path, TomlPosition position)
(package private) MutableTomlTable	createTableArray(List<String> path, TomlPosition position)
(package private) void	define(TomlPosition position)
private MutableTomlTable.EnsureTableResult	ensureTable(List<String> path, TomlPosition position, boolean followTableArrays, boolean followDefinedTables)	Ensure a table exists at a given path.
Set<Map.Entry<List<String>, Object>>	entryPathSet(boolean includeTables)	Get all the entries in this table.
Set<Map.Entry<String,Object>>	entrySet()	Get the entries of this table.
@Nullable Object	get(List<String> path)	Get a value from the TOML document.
private MutableTomlTable.Element	getElement(List<String> path)
@Nullable TomlPosition	inputPositionOf(List<String> path)	Get the position where a key is defined in the TOML document.
(package private) boolean	isDefined()
boolean	isEmpty()	true if there are no entries in this table.
Set<List<String>>	keyPathSet(boolean includeTables)	Get all the paths in this table.
Set<String>	keySet()	Get the keys of this table.
(package private) List<AbstractMap.SimpleEntry<MutableTomlTable, TomlPosition>>	set(String keyPath, Object value, TomlPosition position)
(package private) List<AbstractMap.SimpleEntry<MutableTomlTable, TomlPosition>>	set(List<String> path, Object value, TomlPosition position)
int	size()	Return the number of entries in tis table.
Map<String,Object>	toMap()	Get the elements of this array as a Map.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface TomlTable

contains, contains, dottedEntrySet, dottedEntrySet, dottedKeySet, dottedKeySet, entryPathSet, get, getArray, getArray, 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, getTable, getTable, getTableOrEmpty, getTableOrEmpty, inputPositionOf, isArray, isArray, isBoolean, isBoolean, isDouble, isDouble, isLocalDate, isLocalDate, isLocalDateTime, isLocalDateTime, isLocalTime, isLocalTime, isLong, isLong, isOffsetDateTime, isOffsetDateTime, isString, isString, isTable, isTable, keyPathSet, toJson, toJson, toJson, toJson, toToml, toToml

Field Details

properties

private final Map<String, MutableTomlTable.Element> properties

version

private final TomlVersion version

definedAt

private TomlPosition definedAt

Constructor Details

MutableTomlTable

MutableTomlTable(TomlVersion version,
 TomlPosition definedAt)

MutableTomlTable

MutableTomlTable(TomlVersion version)

Method Details

isDefined

boolean isDefined()

define

void define(TomlPosition position)

size

public int size()

Description copied from interface: TomlTable

Return the number of entries in tis table.

Specified by:

size in interface TomlTable

Returns:

The number of entries in tis table.

isEmpty

public boolean isEmpty()

Description copied from interface: TomlTable

true if there are no entries in this table.

Specified by:

isEmpty in interface TomlTable

Returns:

true if there are no entries in this table.

keySet

public Set<String> keySet()

Description copied from interface: TomlTable

Get the keys of this table.

The returned set contains only immediate keys to this table, and not dotted keys or key paths. For a complete view of keys available in the TOML document, use TomlTable.dottedKeySet() or TomlTable.keyPathSet().

Specified by:

keySet in interface TomlTable

Returns:

A set containing the keys of this table.

keyPathSet

public Set<List<String>> keyPathSet(boolean includeTables)

Description copied from interface: TomlTable

Get all the paths in this table.

Specified by:

keyPathSet in interface TomlTable

Parameters:

includeTables - If true, also include paths to intermediary and empty tables.

Returns:

A set containing all the key paths of this table.

entrySet

public Set<Map.Entry<String,Object>> entrySet()

Description copied from interface: TomlTable

Get the entries of this table.

The returned set contains only immediate entries of this table, and not entries with dotted keys or key paths. For a complete view of all entries available in the TOML document, use TomlTable.dottedEntrySet() or TomlTable.entryPathSet().

Specified by:

entrySet in interface TomlTable

Returns:

A set containing the immediate entries of this table.

entryPathSet

public Set<Map.Entry<List<String>, Object>> entryPathSet(boolean includeTables)

Description copied from interface: TomlTable

Get all the entries in this table.

Specified by:

entryPathSet in interface TomlTable

Parameters:

includeTables - If true, also include entries in intermediary and empty tables.

Returns:

A set containing all the entries of this table.

get

public @Nullable Object get(List<String> path)

Description copied from interface: TomlTable

Get a value from the TOML document.

Specified by:

get in interface TomlTable

Parameters:

path - The key path.

Returns:

The value, or null if no value was set in the TOML document.

inputPositionOf

public @Nullable TomlPosition inputPositionOf(List<String> path)

Description copied from interface: TomlTable

Get the position where a key is defined in the TOML document.

Specified by:

inputPositionOf in interface TomlTable

Parameters:

path - The key path.

Returns:

The input position, or null if the key was not set in the TOML document.

getElement

private MutableTomlTable.Element getElement(List<String> path)

toMap

public Map<String,Object> toMap()

Description copied from interface: TomlTable

Get the elements of this array as a Map.

Note that this does not do a deep conversion. If this array contains tables or arrays, they will be of type TomlTable or TomlArray respectively.

Specified by:

toMap in interface TomlTable

Returns:

The elements of this array as a Map.

createTable

MutableTomlTable createTable(List<String> path,
 TomlPosition position)

createTableArray

MutableTomlTable createTableArray(List<String> path,
 TomlPosition position)

set

List<AbstractMap.SimpleEntry<MutableTomlTable, TomlPosition>> set(String keyPath,
 Object value,
 TomlPosition position)

set

List<AbstractMap.SimpleEntry<MutableTomlTable, TomlPosition>> set(List<String> path,
 Object value,
 TomlPosition position)

ensureTable

private MutableTomlTable.EnsureTableResult ensureTable(List<String> path,
 TomlPosition position,
 boolean followTableArrays,
 boolean followDefinedTables)

Ensure a table exists at a given path.

Parameters:

path - The path to ensure exists (as a table)

position - The input position.

followTableArrays - If `true`, path walking is permitted via the last element of array tables.

followDefinedTables - Allow path walking through defined tables.

Returns:

The

Throws:

TomlParseError - If the table cannot be created.