Package com.github.siroshun09.configapi.core.node

Interface Node<T>

Type Parameters:

T - a type of object

All Known Subinterfaces:

ArrayNode<T>, CommentableNode<T>, ListNode, MapNode, NumberValue, ValueNode<T>

All Known Implementing Classes:

BooleanArray, BooleanValue, ByteArray, ByteValue, CharArray, CharValue, CommentedNode, DoubleArray, DoubleValue, EnumValue, FloatArray, FloatValue, IntArray, IntValue, LongArray, LongValue, NullNode, ObjectNode, ShortArray, ShortValue, StringValue

public sealed interface Node<T>
permits ArrayNode<T>, CommentableNode<T>, NullNode, ObjectNode<T>, ValueNode<T>

An interface that holds an object or value

Method Summary

Modifier and Type	Method	Description
@NotNull VisitResult	accept(@NotNull NodeVisitor visitor)	Accepts a NodeVisitor for this Node.
default @NotNull Optional<T>	asOptional()	Gets an object as Optional.
static @NotNull Node<?>	fromObject(@Nullable Object obj)	Creates a Node from the specified object.
default boolean	hasValue()	Checks if this Node holds an object.
@UnknownNullability T	value()	Gets an object which this Node holds

Method Details

fromObject

@NotNull
static @NotNull Node<?> fromObject(@Nullable
 @Nullable Object obj)

Creates a Node from the specified object.

This method is implemented with the following specifications:

• If the given object is null or NullNode.NULL, returns NullNode.NULL
• If the given object is Node:
  • If the Node is implemented ValueNode, returns it as-is
  • If the Node is ListNode, copies it by using ListNode.copy()
  • If the Node is MapNode, copies it by using MapNode.copy()
  • If the Node is CommentedNode, recreate it with CommentedNode.node() that is passed to this method
  • Other Nodes will be re-created
• If the given object is a array:
  • If the array is a primitive array, returns ArrayNode. (the array will NOT be copied)
  • If the array is an object array, returns ListNode.
• If the given object is String/Enum, creates StringValue/EnumValue
• If the given object is Number, passes the number to NumberValue.fromNumber(Number)
• If the given object is Boolean, passes the boolean to BooleanValue.fromBoolean(Boolean)
• If the given object is implemented Collection, creates ListNode using ListNode.create(java.util.Collection)
• If the given object is implemented Map, creates MapNode using MapNode.create(java.util.Map)
• Otherwise, returns ObjectNode with the given object

Parameters:

obj - the object to create a Node

Returns:

a Node

value

@UnknownNullability T value()

Gets an object which this Node holds

Returns:

an object which this Node holds

hasValue

default boolean hasValue()

Checks if this Node holds an object.

The default implementation of this method checks if the returning value from value() is not null.

Returns:

true if this Node holds an object, otherwise false

asOptional

@NotNull
default @NotNull Optional<T> asOptional()

Gets an object as Optional.

The default implementation of this method returns Optional.ofNullable(Object) which is wrapping value().

Returns:

the Optional

accept

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

Accepts a NodeVisitor for this Node.

Parameters:

visitor - a NodeVisitor to accept

Returns:

a VisitResult