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

Class StringNodeVisitor

java.lang.Object

dev.siroshun.configapi.core.node.visitor.StringNodeVisitor

All Implemented Interfaces:

NodeVisitor

public final class StringNodeVisitor
extends Object
implements NodeVisitor

An implementation of NodeVisitor that represents Nodes as String.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StringNodeVisitor.Appender<T>	An interface to appends an object to StringBuilder.
static final class	StringNodeVisitor.Builder	A builder class of StringNodeVisitor.

Method Summary

Modifier and Type	Method	Description
static void	appendQuoteAndEscapedString(@NotNull String str, @NotNull StringBuilder builder)	Appends the quoted/escaped String to StringBuilder.
static StringNodeVisitor.Builder	builder()	Creates a new StringNodeVisitor.Builder.
static @NotNull StringNodeVisitor	create()	Creates a new StringNodeVisitor.
@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 String	toString()	Gets the result of string representation of Nodes.
@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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

appendQuoteAndEscapedString

public static void appendQuoteAndEscapedString(@NotNull
 @NotNull String str,
 @NotNull
 @NotNull StringBuilder builder)

Appends the quoted/escaped String to StringBuilder.

Parameters:

str - the String to append

builder - a StringBuilder

create

@Contract(" -> new")
@NotNull
public static @NotNull StringNodeVisitor create()

Creates a new StringNodeVisitor.

Returns:

a new StringNodeVisitor

builder

@Contract(value=" -> new",
          pure=true)
@NotNull
public static StringNodeVisitor.Builder builder()

Creates a new StringNodeVisitor.Builder.

Returns:

a new StringNodeVisitor.Builder

visit

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

Description copied from interface: NodeVisitor

Visits a StringValue.

Specified by:

visit in interface NodeVisitor

Parameters:

value - a StringValue being visited

Returns:

a VisitResult

visit

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

Description copied from interface: NodeVisitor

Visits a BooleanArray.

Specified by:

visit in interface NodeVisitor

Parameters:

array - a BooleanArray being visited

Returns:

a VisitResult

visit

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

Description copied from interface: NodeVisitor

Visits a BooleanValue.

Specified by:

visit in interface NodeVisitor

Parameters:

value - a BooleanValue being visited

Returns:

a VisitResult

visit

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

Description copied from interface: NodeVisitor

Visits a ByteArray.

Specified by:

visit in interface NodeVisitor

Parameters:

array - a ByteArray being visited

Returns:

a VisitResult

visit

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

Description copied from interface: NodeVisitor

Visits a ByteValue.

Specified by:

visit in interface NodeVisitor

Parameters:

value - a ByteValue being visited

Returns:

a VisitResult

visit

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

Description copied from interface: NodeVisitor

Visits a CharArray.

Specified by:

visit in interface NodeVisitor

Parameters:

array - a CharArray being visited

Returns:

a VisitResult

visit

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

Description copied from interface: NodeVisitor

Visits a CharValue.

Specified by:

visit in interface NodeVisitor

Parameters:

value - a CharValue being visited

Returns:

a VisitResult

visit

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

Description copied from interface: NodeVisitor

Visits a DoubleArray.

Specified by:

visit in interface NodeVisitor

Parameters:

array - a DoubleArray being visited

Returns:

a VisitResult

visit

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

Description copied from interface: NodeVisitor

Visits a DoubleValue.

Specified by:

visit in interface NodeVisitor

Parameters:

value - a DoubleValue being visited

Returns:

a VisitResult

visit

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

Description copied from interface: NodeVisitor

Visits a FloatArray.

Specified by:

visit in interface NodeVisitor

Parameters:

array - a FloatArray being visited

Returns:

a VisitResult

visit

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

Description copied from interface: NodeVisitor

Visits a FloatValue.

Specified by:

visit in interface NodeVisitor

Parameters:

value - a FloatValue being visited

Returns:

a VisitResult

visit

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

Description copied from interface: NodeVisitor

Visits a IntArray.

Specified by:

visit in interface NodeVisitor

Parameters:

array - a IntArray being visited

Returns:

a VisitResult

visit

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

Description copied from interface: NodeVisitor

Visits a IntValue.

Specified by:

visit in interface NodeVisitor

Parameters:

value - a IntValue being visited

Returns:

a VisitResult

visit

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

Description copied from interface: NodeVisitor

Visits a LongArray.

Specified by:

visit in interface NodeVisitor

Parameters:

array - a LongArray being visited

Returns:

a VisitResult

visit

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

Description copied from interface: NodeVisitor

Visits a LongValue.

Specified by:

visit in interface NodeVisitor

Parameters:

value - a LongValue being visited

Returns:

a VisitResult

visit

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

Description copied from interface: NodeVisitor

Visits a ShortArray.

Specified by:

visit in interface NodeVisitor

Parameters:

array - a ShortArray being visited

Returns:

a VisitResult

visit

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

Description copied from interface: NodeVisitor

Visits a ShortValue.

Specified by:

visit in interface NodeVisitor

Parameters:

value - a ShortValue being visited

Returns:

a VisitResult

visit

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

Description copied from interface: NodeVisitor

Visits a EnumValue.

Specified by:

visit in interface NodeVisitor

Parameters:

value - a EnumValue being visited

Returns:

a VisitResult

visit

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

Description copied from interface: NodeVisitor

Visits a ObjectNode.

Specified by:

visit in interface NodeVisitor

Parameters:

node - a ObjectNode being visited

Returns:

a VisitResult

startList

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

Description copied from interface: NodeVisitor

Starts visiting a ListNode.

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

Specified by:

startList in interface NodeVisitor

Parameters:

node - a ListNode being visited

Returns:

a VisitResult

visitElement

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

Description copied from interface: NodeVisitor

Visits ListNode's element.

If this method returns:

• VisitResult.CONTINUE - Calls Node.accept(NodeVisitor) of the element
• VisitResult.BREAK - Stops visiting elements and calls NodeVisitor.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

Specified by:

visitElement in interface NodeVisitor

Parameters:

index - the index of the element in the list

node - the element

Returns:

a VisitResult

endList

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

Description copied from interface: NodeVisitor

Ends visiting a ListNode.

Specified by:

endList in interface NodeVisitor

Parameters:

node - a ListNode being visited

Returns:

a VisitResult

startMap

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

Description copied from interface: NodeVisitor

Starts visiting a MapNode.

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

Specified by:

startMap in interface NodeVisitor

Parameters:

node - a MapNode being visited

Returns:

a VisitResult

visitEntry

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

Description copied from interface: NodeVisitor

Visits MapNode's entry.

If this method returns:

• VisitResult.CONTINUE - Calls Node.accept(NodeVisitor) of the entry
• VisitResult.BREAK - Stops visiting entries and calls NodeVisitor.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

Specified by:

visitEntry in interface NodeVisitor

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
public @NotNull VisitResult endMap(@NotNull
 @NotNull MapNode node)

Description copied from interface: NodeVisitor

Ends visiting a MapNode.

Specified by:

endMap in interface NodeVisitor

Parameters:

node - a MapNode being visited

Returns:

a VisitResult

visit

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

Description copied from interface: NodeVisitor

Visits a CommentedNode.

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

Specified by:

visit in interface NodeVisitor

Parameters:

node - a CommentedNode being visited

Returns:

a VisitResult

visit

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

Description copied from interface: NodeVisitor

Visits a NullNode.

Specified by:

visit in interface NodeVisitor

Parameters:

node - a NullNode being visited

Returns:

a VisitResult

toString

@Contract(pure=true)
@NotNull
public @NotNull String toString()

Gets the result of string representation of Nodes.

Overrides:

toString in class Object

Returns:

the result of string representation of Nodes