Package dev.siroshun.configapi.core.node

Interface CommentableNode<T>

Type Parameters:

T - a type of object

All Superinterfaces:

Node<T>

All Known Subinterfaces:

ListNode, MapNode

All Known Implementing Classes:

CommentedNode

@Experimental
public sealed interface CommentableNode<T>
extends Node<T>
permits CommentedNode<T>, ListNode, MapNode

An interface indicating that the Node can have the Comment.

Method Summary

Modifier and Type	Method	Description
@NotNull Comment	getComment()	Gets the Comment.
default @Nullable Comment	getCommentOrNull()	Gets the Comment or null if this CommentableNode does not have the Comment.
boolean	hasComment()	Checks if this CommentableNode has the Comment.
void	setComment(@Nullable Comment comment)	Sets the Comment.
static <T> @NotNull CommentableNode<T>	withComment(@NotNull Node<T> target, @Nullable Comment comment)	Creates a CommentableNode with the specified Comment.

Methods inherited from interface dev.siroshun.configapi.core.node.Node

accept, asOptional, hasValue, value

Method Details

withComment

@NotNull
static <T> @NotNull CommentableNode<T> withComment(@NotNull
 @NotNull Node<T> target,
 @Nullable
 @Nullable Comment comment)

Creates a CommentableNode with the specified Comment.

If target is a CommentableNode, set the specified Comment using setComment(Comment). Otherwise, wrap the target in CommentedNode and attach the Comment.

Type Parameters:

T - a type of object

Parameters:

target - the Node to attach the comment to

comment - the Comment to attach

Returns:

the CommentableNode

hasComment

boolean hasComment()

Checks if this CommentableNode has the Comment.

Returns:

true if this CommentableNode has the Comment, otherwise false

getComment

@NotNull
@NotNull Comment getComment()

Gets the Comment.

Returns:

the Comment

Throws:

IllegalStateException - if this CommentableNode does not have the Comment

getCommentOrNull

@Nullable
default @Nullable Comment getCommentOrNull()

Gets the Comment or null if this CommentableNode does not have the Comment.

Returns:

the Comment or null if this CommentableNode does not have the Comment

setComment

void setComment(@Nullable
 @Nullable Comment comment)

Sets the Comment.

Parameters:

comment - the Comment or null to remove the current Comment