org.tomlj

Interface TomlArray

public interface TomlArray

An array of TOML values.

Method Summary

Modifier and Type	Method and Description
boolean	containsArrays()
boolean	containsBooleans()
boolean	containsDoubles()
boolean	containsLocalDates()
boolean	containsLocalDateTimes()
boolean	containsLocalTimes()
boolean	containsLongs()
boolean	containsOffsetDateTimes()
boolean	containsStrings()
boolean	containsTables()
java.lang.Object	get(int index) Get a value at a specified index.
default TomlArray	getArray(int index) Get an array at a specified index.
default boolean	getBoolean(int index) Get a boolean at a specified index.
default double	getDouble(int index) Get a double at a specified index.
default java.time.LocalDate	getLocalDate(int index) Get a local date at a specified index.
default java.time.LocalDateTime	getLocalDateTime(int index) Get a local date time at a specified index.
default java.time.LocalTime	getLocalTime(int index) Get a local time at a specified index.
default long	getLong(int index) Get a long at a specified index.
default java.time.OffsetDateTime	getOffsetDateTime(int index) Get an offset date time at a specified index.
default java.lang.String	getString(int index) Get a string at a specified index.
default TomlTable	getTable(int index) Get a table at a specified index.
TomlPosition	inputPositionOf(int index) Get the position where a value is defined in the TOML document.
boolean	isEmpty()
int	size()
default java.lang.String	toJson() Return a representation of this array using JSON.
default void	toJson(java.lang.Appendable appendable) Append a JSON representation of this array to the appendable output.
java.util.List<java.lang.Object>	toList() Get the elements of this array as a List.

Method Detail

size

int size()

Returns:

The size of the array.

isEmpty

boolean isEmpty()

Returns:

true if the array is empty.

containsStrings

boolean containsStrings()

Returns:

true if the array contains strings.

containsLongs

boolean containsLongs()

Returns:

true if the array contains longs.

containsDoubles

boolean containsDoubles()

Returns:

true if the array contains doubles.

containsBooleans

boolean containsBooleans()

Returns:

true if the array contains booleans.

containsOffsetDateTimes

boolean containsOffsetDateTimes()

Returns:

true if the array contains OffsetDateTimes.

containsLocalDateTimes

boolean containsLocalDateTimes()

Returns:

true if the array contains LocalDateTimes.

containsLocalDates

boolean containsLocalDates()

Returns:

true if the array contains LocalDates.

containsLocalTimes

boolean containsLocalTimes()

Returns:

true if the array contains LocalTimes.

containsArrays

boolean containsArrays()

Returns:

true if the array contains arrays.

containsTables

boolean containsTables()

Returns:

true if the array contains tables.

get

java.lang.Object get(int index)

Get a value at a specified index.

Parameters:

index - The array index.

Returns:

The value.

Throws:

java.lang.IndexOutOfBoundsException - If the index is out of bounds.

inputPositionOf

TomlPosition inputPositionOf(int index)

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

Parameters:

index - The array index.

Returns:

The input position.

Throws:

java.lang.IndexOutOfBoundsException - If the index is out of bounds.

getString

default java.lang.String getString(int index)

Get a string at a specified index.

Parameters:

index - The array index.

Returns:

The value.

Throws:

java.lang.IndexOutOfBoundsException - If the index is out of bounds.

TomlInvalidTypeException - If the value is not a long.

getLong

default long getLong(int index)

Get a long at a specified index.

Parameters:

index - The array index.

Returns:

The value.

Throws:

java.lang.IndexOutOfBoundsException - If the index is out of bounds.

TomlInvalidTypeException - If the value is not a long.

getDouble

default double getDouble(int index)

Get a double at a specified index.

Parameters:

index - The array index.

Returns:

The value.

Throws:

java.lang.IndexOutOfBoundsException - If the index is out of bounds.

TomlInvalidTypeException - If the value is not a long.

getBoolean

default boolean getBoolean(int index)

Get a boolean at a specified index.

Parameters:

index - The array index.

Returns:

The value.

Throws:

java.lang.IndexOutOfBoundsException - If the index is out of bounds.

TomlInvalidTypeException - If the value is not a long.

getOffsetDateTime

default java.time.OffsetDateTime getOffsetDateTime(int index)

Get an offset date time at a specified index.

Parameters:

index - The array index.

Returns:

The value.

Throws:

java.lang.IndexOutOfBoundsException - If the index is out of bounds.

TomlInvalidTypeException - If the value is not an OffsetDateTime.

getLocalDateTime

default java.time.LocalDateTime getLocalDateTime(int index)

Get a local date time at a specified index.

Parameters:

index - The array index.

Returns:

The value.

Throws:

java.lang.IndexOutOfBoundsException - If the index is out of bounds.

TomlInvalidTypeException - If the value is not an LocalDateTime.

getLocalDate

default java.time.LocalDate getLocalDate(int index)

Get a local date at a specified index.

Parameters:

index - The array index.

Returns:

The value.

Throws:

java.lang.IndexOutOfBoundsException - If the index is out of bounds.

TomlInvalidTypeException - If the value is not an LocalDate.

getLocalTime

default java.time.LocalTime getLocalTime(int index)

Get a local time at a specified index.

Parameters:

index - The array index.

Returns:

The value.

Throws:

java.lang.IndexOutOfBoundsException - If the index is out of bounds.

TomlInvalidTypeException - If the value is not an LocalTime.

getArray

default TomlArray getArray(int index)

Get an array at a specified index.

Parameters:

index - The array index.

Returns:

The value.

Throws:

java.lang.IndexOutOfBoundsException - If the index is out of bounds.

TomlInvalidTypeException - If the value is not an array.

getTable

default TomlTable getTable(int index)

Get a table at a specified index.

Parameters:

index - The array index.

Returns:

The value.

Throws:

java.lang.IndexOutOfBoundsException - If the index is out of bounds.

TomlInvalidTypeException - If the value is not a table.

toList

java.util.List<java.lang.Object> toList()

Get the elements of this array as a List.

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.

Returns:

The elements of this array as a List.

toJson

default java.lang.String toJson()

Return a representation of this array using JSON.

Returns:

A JSON representation of this array.

toJson

default void toJson(java.lang.Appendable appendable)
             throws java.io.IOException

Append a JSON representation of this array to the appendable output.

Parameters:

appendable - The appendable output.

Throws:

java.io.IOException - If an IO error occurs.