Package org.tomlj

Interface TomlEntry

All Superinterfaces:

TomlElement

All Known Subinterfaces:

MutableTomlEntry, MutableTomlKeyValue, TomlKeyValue

public interface TomlEntry
extends TomlElement

An entry of a table or array: the slot a container indexes, with the value it holds and the comments attached to it.

A table's entries are TomlKeyValues; an array's entries are plain TomlEntrys. The other kind of element a container's elements() holds is an unattached TomlComment, which is not an entry.

Method Summary

Modifier and Type	Method	Description
default @Nullable TomlComment	comment(TomlComment.Placement placement)	The comment attached to this entry at a placement.
List<TomlComment>	comments()	The comments attached to this entry.
TomlValue	value()	The value this entry holds.

Methods inherited from interface org.tomlj.TomlElement

position

Method Details

value

TomlValue value()

The value this entry holds.

Returns:

The value.

comments

List<TomlComment> comments()

The comments attached to this entry.

Returns the comments in document order: the run written directly above it, if any, then the comment on its line, if any, so at most two, each with its TomlComment.placement(). These are the comments TomlTable.comments(List) returns for a key and TomlArray.comments(int) for an index.

Returns:

The attached comments, in document order. Unmodifiable.

comment

default @Nullable TomlComment comment(TomlComment.Placement placement)

The comment attached to this entry at a placement.

Parameters:

placement - TomlComment.Placement.ABOVE for the run written directly above this entry, or TomlComment.Placement.AFTER for the comment on its line.

Returns:

The comment at that placement, or null if this entry has none there.

Throws:

NullPointerException - If placement is null.

IllegalArgumentException - If placement is TomlComment.Placement.UNATTACHED, since no entry holds an unattached comment.