Package dev.siroshun.configapi.core.node

Class CommentedNode<T>

java.lang.Object

dev.siroshun.configapi.core.node.CommentedNode<T>

Type Parameters:

T - a type of object

All Implemented Interfaces:

CommentableNode<T>, Node<T>

public final class CommentedNode<T>
extends Object
implements CommentableNode<T>

An implementation class of the CommentableNode to wrap the non-CommentableNode node and attach the Comment.

Method Summary

Modifier and Type	Method	Description
@NotNull VisitResult	accept(@NotNull NodeVisitor visitor)	Accepts a NodeVisitor for this Node.
boolean	equals(Object object)
@NotNull Comment	getComment()	Gets the Comment.
boolean	hasComment()	Checks if this CommentableNode has the Comment.
int	hashCode()
@NotNull Node<T>	node()	Gets the wrapped Node.
void	setComment(@Nullable Comment comment)	Sets the Comment.
String	toString()
@UnknownNullability T	value()	Gets an object which this Node holds

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getCommentOrNull

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

asOptional, hasValue

Method Details

value

public @UnknownNullability T value()

Description copied from interface: Node

Gets an object which this Node holds

Specified by:

value in interface Node<T>

Returns:

an object which this Node holds

node

@NotNull
public @NotNull Node<T> node()

Gets the wrapped Node.

Returns:

the wrapped Node

hasComment

public boolean hasComment()

Description copied from interface: CommentableNode

Checks if this CommentableNode has the Comment.

Specified by:

hasComment in interface CommentableNode<T>

Returns:

true if this CommentableNode has the Comment, otherwise false

getComment

@NotNull
public @NotNull Comment getComment()

Description copied from interface: CommentableNode

Gets the Comment.

Specified by:

getComment in interface CommentableNode<T>

Returns:

the Comment

setComment

public void setComment(@Nullable
 @Nullable Comment comment)

Description copied from interface: CommentableNode

Sets the Comment.

Specified by:

setComment in interface CommentableNode<T>

Parameters:

comment - the Comment or null to remove the current Comment

accept

@NotNull
public @NotNull VisitResult accept(@NotNull
 @NotNull NodeVisitor visitor)

Description copied from interface: Node

Accepts a NodeVisitor for this Node.

Specified by:

accept in interface Node<T>

Parameters:

visitor - a NodeVisitor to accept

Returns:

a VisitResult

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object