Package dev.siroshun.configapi.core.node.visitor

Interface NodeVisitor

All Known Implementing Classes:

StringNodeVisitor

public interface NodeVisitor

A visitor of Nodes.

This interface can be used through Node.accept(NodeVisitor).

Method Summary

Modifier and Type	Method	Description
@NotNull VisitResult	endList(@NotNull ListNode node)	Ends visiting a ListNode.
@NotNull VisitResult	endMap(@NotNull MapNode node)	Ends visiting a MapNode.
@NotNull VisitResult	startList(@NotNull ListNode node)	Starts visiting a ListNode.
@NotNull VisitResult	startMap(@NotNull MapNode node)	Starts visiting a MapNode.
@NotNull VisitResult	visit(@NotNull BooleanArray array)	Visits a BooleanArray.
@NotNull VisitResult	visit(@NotNull BooleanValue value)	Visits a BooleanValue.
@NotNull VisitResult	visit(@NotNull ByteArray array)	Visits a ByteArray.
@NotNull VisitResult	visit(@NotNull ByteValue value)	Visits a ByteValue.
@NotNull VisitResult	visit(@NotNull CharArray array)	Visits a CharArray.
@NotNull VisitResult	visit(@NotNull CharValue value)	Visits a CharValue.
@NotNull VisitResult	visit(@NotNull CommentedNode<?> node)	Visits a CommentedNode.
@NotNull VisitResult	visit(@NotNull DoubleArray array)	Visits a DoubleArray.
@NotNull VisitResult	visit(@NotNull DoubleValue value)	Visits a DoubleValue.
@NotNull VisitResult	visit(@NotNull EnumValue<?> value)	Visits a EnumValue.
@NotNull VisitResult	visit(@NotNull FloatArray array)	Visits a FloatArray.
@NotNull VisitResult	visit(@NotNull FloatValue value)	Visits a FloatValue.
@NotNull VisitResult	visit(@NotNull IntArray array)	Visits a IntArray.
@NotNull VisitResult	visit(@NotNull IntValue value)	Visits a IntValue.
@NotNull VisitResult	visit(@NotNull LongArray array)	Visits a LongArray.
@NotNull VisitResult	visit(@NotNull LongValue value)	Visits a LongValue.
@NotNull VisitResult	visit(@NotNull NullNode node)	Visits a NullNode.
@NotNull VisitResult	visit(@NotNull ObjectNode<?> node)	Visits a ObjectNode.
@NotNull VisitResult	visit(@NotNull ShortArray array)	Visits a ShortArray.
@NotNull VisitResult	visit(@NotNull ShortValue value)	Visits a ShortValue.
@NotNull VisitResult	visit(@NotNull StringValue value)	Visits a StringValue.
@NotNull VisitResult	visitElement(int index, @NotNull Node<?> node)	Visits ListNode's element.
@NotNull VisitResult	visitEntry(int num, @NotNull Object key, @NotNull Node<?> node)	Visits MapNode's entry.

Method Details

visit

@NotNull
@NotNull VisitResult visit(@NotNull
 @NotNull StringValue value)

Visits a StringValue.

Parameters:

value - a StringValue being visited

Returns:

a VisitResult

visit

@NotNull
@NotNull VisitResult visit(@NotNull
 @NotNull BooleanArray array)

Visits a BooleanArray.

Parameters:

array - a BooleanArray being visited

Returns:

a VisitResult

visit

@NotNull
@NotNull VisitResult visit(@NotNull
 @NotNull BooleanValue value)

Visits a BooleanValue.

Parameters:

value - a BooleanValue being visited

Returns:

a VisitResult

visit

@NotNull
@NotNull VisitResult visit(@NotNull
 @NotNull ByteArray array)

Visits a ByteArray.

Parameters:

array - a ByteArray being visited

Returns:

a VisitResult

visit

@NotNull
@NotNull VisitResult visit(@NotNull
 @NotNull ByteValue value)

Visits a ByteValue.

Parameters:

value - a ByteValue being visited

Returns:

a VisitResult

visit

@NotNull
@NotNull VisitResult visit(@NotNull
 @NotNull CharArray array)

Visits a CharArray.

Parameters:

array - a CharArray being visited

Returns:

a VisitResult

visit

@NotNull
@NotNull VisitResult visit(@NotNull
 @NotNull CharValue value)

Visits a CharValue.

Parameters:

value - a CharValue being visited

Returns:

a VisitResult

visit

@NotNull
@NotNull VisitResult visit(@NotNull
 @NotNull DoubleArray array)

Visits a DoubleArray.

Parameters:

array - a DoubleArray being visited

Returns:

a VisitResult

visit

@NotNull
@NotNull VisitResult visit(@NotNull
 @NotNull DoubleValue value)

Visits a DoubleValue.

Parameters:

value - a DoubleValue being visited

Returns:

a VisitResult

visit

@NotNull
@NotNull VisitResult visit(@NotNull
 @NotNull FloatArray array)

Visits a FloatArray.

Parameters:

array - a FloatArray being visited

Returns:

a VisitResult

visit

@NotNull
@NotNull VisitResult visit(@NotNull
 @NotNull FloatValue value)

Visits a FloatValue.

Parameters:

value - a FloatValue being visited

Returns:

a VisitResult

visit

@NotNull
@NotNull VisitResult visit(@NotNull
 @NotNull IntArray array)

Visits a IntArray.

Parameters:

array - a IntArray being visited

Returns:

a VisitResult

visit

@NotNull
@NotNull VisitResult visit(@NotNull
 @NotNull IntValue value)

Visits a IntValue.

Parameters:

value - a IntValue being visited

Returns:

a VisitResult

visit

@NotNull
@NotNull VisitResult visit(@NotNull
 @NotNull LongArray array)

Visits a LongArray.

Parameters:

array - a LongArray being visited

Returns:

a VisitResult

visit

@NotNull
@NotNull VisitResult visit(@NotNull
 @NotNull LongValue value)

Visits a LongValue.

Parameters:

value - a LongValue being visited

Returns:

a VisitResult

visit

@NotNull
@NotNull VisitResult visit(@NotNull
 @NotNull ShortArray array)

Visits a ShortArray.

Parameters:

array - a ShortArray being visited

Returns:

a VisitResult

visit

@NotNull
@NotNull VisitResult visit(@NotNull
 @NotNull ShortValue value)

Visits a ShortValue.

Parameters:

value - a ShortValue being visited

Returns:

a VisitResult

visit

@NotNull
@NotNull VisitResult visit(@NotNull
 @NotNull EnumValue<?> value)

Visits a EnumValue.

Parameters:

value - a EnumValue being visited

Returns:

a VisitResult

visit

@NotNull
@NotNull VisitResult visit(@NotNull
 @NotNull ObjectNode<?> node)

Visits a ObjectNode.

Parameters:

node - a ObjectNode being visited

Returns:

a VisitResult

startList

@NotNull
@NotNull VisitResult startList(@NotNull
 @NotNull ListNode node)

Starts visiting a ListNode.

If this method returns VisitResult.SKIP or VisitResult.STOP, Node.accept(NodeVisitor) will not visit its elements.

Parameters:

node - a ListNode being visited

Returns:

a VisitResult

visitElement

@NotNull
@NotNull VisitResult visitElement(int index,
 @NotNull
 @NotNull Node<?> node)

Visits ListNode's element.

If this method returns:

• VisitResult.CONTINUE - Calls Node.accept(NodeVisitor) of the element
• VisitResult.BREAK - Stops visiting elements and calls endList(ListNode)
• VisitResult.SKIP - Skips the element (Node.accept(NodeVisitor) of the element will not be called)
• VisitResult.STOP - Stop visiting immediately and Node.accept(NodeVisitor) will returns VisitResult.STOP

Parameters:

index - the index of the element in the list

node - the element

Returns:

a VisitResult

endList

@NotNull
@NotNull VisitResult endList(@NotNull
 @NotNull ListNode node)

Ends visiting a ListNode.

Parameters:

node - a ListNode being visited

Returns:

a VisitResult

startMap

@NotNull
@NotNull VisitResult startMap(@NotNull
 @NotNull MapNode node)

Starts visiting a MapNode.

If this method returns VisitResult.SKIP or VisitResult.STOP, Node.accept(NodeVisitor) will not visit its entries.

Parameters:

node - a MapNode being visited

Returns:

a VisitResult

visitEntry

@NotNull
@NotNull VisitResult visitEntry(int num,
 @NotNull
 @NotNull Object key,
 @NotNull
 @NotNull Node<?> node)

Visits MapNode's entry.

If this method returns:

• VisitResult.CONTINUE - Calls Node.accept(NodeVisitor) of the entry
• VisitResult.BREAK - Stops visiting entries and calls endMap(MapNode)
• VisitResult.SKIP - Skips the entry (Node.accept(NodeVisitor) of the entry will not be called)
• VisitResult.STOP - Stop visiting immediately and Node.accept(NodeVisitor) will returns VisitResult.STOP

Parameters:

num - the number of the entry in the map

key - the key of the entry

node - the value of the entry

Returns:

a VisitResult

endMap

@NotNull
@NotNull VisitResult endMap(@NotNull
 @NotNull MapNode node)

Ends visiting a MapNode.

Parameters:

node - a MapNode being visited

Returns:

a VisitResult

visit

@NotNull
@NotNull VisitResult visit(@NotNull
 @NotNull CommentedNode<?> node)

Visits a CommentedNode.

If this method returns VisitResult.CONTINUE, CommentedNode.accept(NodeVisitor) will call Node.accept(NodeVisitor) of CommentedNode.node() and returns its result.

Parameters:

node - a CommentedNode being visited

Returns:

a VisitResult

visit

@NotNull
@NotNull VisitResult visit(@NotNull
 @NotNull NullNode node)

Visits a NullNode.

Parameters:

node - a NullNode being visited

Returns:

a VisitResult