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

Class StringNodeVisitor

java.lang.Object

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

All Implemented Interfaces:

NodeVisitor

@NotNullByDefault
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(String str, StringBuilder builder)	Appends the quoted/escaped String to StringBuilder.
static StringNodeVisitor.Builder	builder()	Creates a new StringNodeVisitor.Builder.
static StringNodeVisitor	create()	Creates a new StringNodeVisitor.
VisitResult	endList(ListNode node)	Ends visiting a ListNode.
VisitResult	endMap(MapNode node)	Ends visiting a MapNode.
VisitResult	startList(ListNode node)	Starts visiting a ListNode.
VisitResult	startMap(MapNode node)	Starts visiting a MapNode.
String	toString()	Gets the result of string representation of Nodes.
VisitResult	visit(BooleanArray array)	Visits a BooleanArray.
VisitResult	visit(BooleanValue value)	Visits a BooleanValue.
VisitResult	visit(ByteArray array)	Visits a ByteArray.
VisitResult	visit(ByteValue value)	Visits a ByteValue.
VisitResult	visit(CharArray array)	Visits a CharArray.
VisitResult	visit(CharValue value)	Visits a CharValue.
VisitResult	visit(CommentedNode<?> node)	Visits a CommentedNode.
VisitResult	visit(DoubleArray array)	Visits a DoubleArray.
VisitResult	visit(DoubleValue value)	Visits a DoubleValue.
VisitResult	visit(EnumValue<?> value)	Visits a EnumValue.
VisitResult	visit(FloatArray array)	Visits a FloatArray.
VisitResult	visit(FloatValue value)	Visits a FloatValue.
VisitResult	visit(IntArray array)	Visits a IntArray.
VisitResult	visit(IntValue value)	Visits a IntValue.
VisitResult	visit(LongArray array)	Visits a LongArray.
VisitResult	visit(LongValue value)	Visits a LongValue.
VisitResult	visit(NullNode node)	Visits a NullNode.
VisitResult	visit(ObjectNode<?> node)	Visits a ObjectNode.
VisitResult	visit(ShortArray array)	Visits a ShortArray.
VisitResult	visit(ShortValue value)	Visits a ShortValue.
VisitResult	visit(StringValue value)	Visits a StringValue.
VisitResult	visitElement(int index, Node<?> node)	Visits ListNode's element.
VisitResult	visitEntry(int num, Object key, 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(String str,
 StringBuilder builder)

Appends the quoted/escaped String to StringBuilder.

Parameters:

str - the String to append

builder - a StringBuilder

create

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

Creates a new StringNodeVisitor.

Returns:

a new StringNodeVisitor

builder

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

Creates a new StringNodeVisitor.Builder.

Returns:

a new StringNodeVisitor.Builder

visit

public VisitResult visit(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

public VisitResult visit(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

public VisitResult visit(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

public VisitResult visit(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

public VisitResult visit(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

public VisitResult visit(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

public VisitResult visit(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

public VisitResult visit(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

public VisitResult visit(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

public VisitResult visit(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

public VisitResult visit(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

public VisitResult visit(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

public VisitResult visit(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

public VisitResult visit(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

public VisitResult visit(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

public VisitResult visit(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

public VisitResult visit(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

public VisitResult visit(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

public VisitResult visit(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

public VisitResult startList(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

public VisitResult visitElement(int index,
 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

public VisitResult endList(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

public VisitResult startMap(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

public VisitResult visitEntry(int num,
 Object key,
 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

public VisitResult endMap(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

public VisitResult visit(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

public VisitResult visit(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)
public String toString()

Gets the result of string representation of Nodes.

Overrides:

toString in class Object

Returns:

the result of string representation of Nodes