Package io.github.wasabithumb.jtoml.comment

Interface Comment

@NonExtendable
@AvailableSince("0.6.0")
public interface Comment

Represents a TOML comment. Also holds helper annotations for use in reflect serialization (@Comment.Pre, @Comment.Post, @Comment.Inline), not to be confused with the CommentPosition enum constants.

See Also:

• position()
• content()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static @interface	Comment.Inline	Annotation for use in reflect serialization.
static @interface	Comment.Post	Annotation for use in reflect serialization.
static @interface	Comment.Pre	Annotation for use in reflect serialization.

Method Summary

Modifier and Type	Method	Description
@NotNull String	content()	Raw text contained within the comment
static @NotNull Comment	of(@NotNull CommentPosition position, @NotNull String content)
@NotNull CommentPosition	position()	Position of the comment

Method Details

of

@Contract("_, _ -> new")
@NotNull
static @NotNull Comment of(@NotNull
 @NotNull CommentPosition position,
 @NotNull
 @NotNull String content)

position

@NotNull
@NotNull CommentPosition position()

Position of the comment

content

@NotNull
@NotNull String content()

Raw text contained within the comment