ch.jalu.configme.resource.yaml

Class SnakeYamlNodeBuilderImpl

java.lang.Object

ch.jalu.configme.resource.yaml.SnakeYamlNodeBuilderImpl

All Implemented Interfaces:

SnakeYamlNodeBuilder

public class SnakeYamlNodeBuilderImpl
extends Object
implements SnakeYamlNodeBuilder

Default implementation of SnakeYamlNodeBuilder: creates SnakeYAML nodes for values and comments.

Constructor Summary

Constructors

Constructor and Description
SnakeYamlNodeBuilderImpl()

Method Summary

Modifier and Type	Method and Description
protected @NotNull List<org.yaml.snakeyaml.comments.CommentLine>	collectComments(@NotNull Object value, @NotNull String path, @NotNull ConfigurationData configurationData, int numberOfNewLines) Creates comments based on all possible sources (number of empty lines, configuration data, ValueWithComments) and returns them as SnakeYAML comment lines.
protected @NotNull org.yaml.snakeyaml.nodes.Node	createBooleanNode(boolean value)
@NotNull Stream<org.yaml.snakeyaml.comments.CommentLine>	createCommentLines(@NotNull String comment) Creates SnakeYAML CommentLine objects to represent the given comment.
@NotNull org.yaml.snakeyaml.nodes.Node	createKeyNode(@NotNull String key) Creates a SnakeYAML string node for a key value (e.g.
protected @NotNull org.yaml.snakeyaml.nodes.Node	createMapNode(@NotNull Map<String,?> value, String path, @NotNull ConfigurationData configurationData) Creates a SnakeYAML node representing a map (collection of key-value pairs).
protected @NotNull org.yaml.snakeyaml.nodes.Node	createNumberNode(@NotNull Number value)
protected @NotNull org.yaml.snakeyaml.nodes.Node	createSequenceNode(@NotNull Stream<?> entries, @NotNull String path, @NotNull ConfigurationData configurationData) Creates a SnakeYAML node representing a sequence of the entries in the stream.
protected @NotNull org.yaml.snakeyaml.nodes.Node	createStringNode(@NotNull String value)
@NotNull org.yaml.snakeyaml.nodes.Node	createYamlNode(@NotNull Object obj, @NotNull String path, @NotNull ConfigurationData configurationData, int numberOfNewLines) Creates a SnakeYAML node representing the given value.
protected @NotNull Set<UUID>	getUsedUniqueCommentIds()
void	transferComments(@NotNull org.yaml.snakeyaml.nodes.Node valueNode, @NotNull org.yaml.snakeyaml.nodes.Node keyNode) Transfers the comments from the value node to the key node.

Methods inherited from class java.lang.Object

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

Constructor Detail

SnakeYamlNodeBuilderImpl

public SnakeYamlNodeBuilderImpl()

Method Detail

createYamlNode

@NotNull
public @NotNull org.yaml.snakeyaml.nodes.Node createYamlNode(@NotNull
                                                                      @NotNull Object obj,
                                                                      @NotNull
                                                                      @NotNull String path,
                                                                      @NotNull
                                                                      @NotNull ConfigurationData configurationData,
                                                                      int numberOfNewLines)

Description copied from interface: SnakeYamlNodeBuilder

Creates a SnakeYAML node representing the given value.

Specified by:

createYamlNode in interface SnakeYamlNodeBuilder

Parameters:

obj - the value to create the node for (export value of a property)

path - the path of the property whose value is exported

configurationData - configuration data (for the retrieval of comments)

numberOfNewLines - number of new lines before the property, to add as new lines to the node

Returns:

SnakeYAML node of the appropriate type for the value, including comments

createKeyNode

@NotNull
public @NotNull org.yaml.snakeyaml.nodes.Node createKeyNode(@NotNull
                                                                     @NotNull String key)

Description copied from interface: SnakeYamlNodeBuilder

Creates a SnakeYAML string node for a key value (e.g. object property, or map key).

Specified by:

createKeyNode in interface SnakeYamlNodeBuilder

Parameters:

key - the key to wrap into a node

Returns:

a node representing the key value

createCommentLines

@NotNull
public @NotNull Stream<org.yaml.snakeyaml.comments.CommentLine> createCommentLines(@NotNull
                                                                                            @NotNull String comment)

Description copied from interface: SnakeYamlNodeBuilder

Creates SnakeYAML CommentLine objects to represent the given comment. If the comment is equal to the new line character \n, one comment line representing a blank line is returned. Otherwise, a comment line is created for each line (the text is split by \n).

Specified by:

createCommentLines in interface SnakeYamlNodeBuilder

Parameters:

comment - the comment to represent as CommentLine

Returns:

stream with comment line objects representing the given comment

transferComments

public void transferComments(@NotNull
                             @NotNull org.yaml.snakeyaml.nodes.Node valueNode,
                             @NotNull
                             @NotNull org.yaml.snakeyaml.nodes.Node keyNode)

Description copied from interface: SnakeYamlNodeBuilder

Transfers the comments from the value node to the key node. Logically, comments are associated with values, but we do not want the comments to appear between the key and the value in the YAML output. Therefore, this method is called before producing YAML as to move the comments from the value to the key node.

Specified by:

transferComments in interface SnakeYamlNodeBuilder

Parameters:

valueNode - the value node to remove the comments from

keyNode - the key node to set the comments to

createStringNode

@NotNull
protected @NotNull org.yaml.snakeyaml.nodes.Node createStringNode(@NotNull
                                                                           @NotNull String value)

createNumberNode

@NotNull
protected @NotNull org.yaml.snakeyaml.nodes.Node createNumberNode(@NotNull
                                                                           @NotNull Number value)

createBooleanNode

@NotNull
protected @NotNull org.yaml.snakeyaml.nodes.Node createBooleanNode(boolean value)

createSequenceNode

@NotNull
protected @NotNull org.yaml.snakeyaml.nodes.Node createSequenceNode(@NotNull
                                                                             @NotNull Stream<?> entries,
                                                                             @NotNull
                                                                             @NotNull String path,
                                                                             @NotNull
                                                                             @NotNull ConfigurationData configurationData)

Creates a SnakeYAML node representing a sequence of the entries in the stream.

Parameters:

entries - stream of the entries (from a Java collection or array)

path - the property path

configurationData - the configuration data (to retrieve comments)

Returns:

SnakeYAML node representing the entries

createMapNode

@NotNull
protected @NotNull org.yaml.snakeyaml.nodes.Node createMapNode(@NotNull
                                                                        @NotNull Map<String,?> value,
                                                                        String path,
                                                                        @NotNull
                                                                        @NotNull ConfigurationData configurationData)

Creates a SnakeYAML node representing a map (collection of key-value pairs).

Parameters:

value - the map whose values should be in the returned node

path - the property path

configurationData - the configuration data (to retrieve comments)

Returns:

SnakeYAML node representing the given map

collectComments

@NotNull
protected @NotNull List<org.yaml.snakeyaml.comments.CommentLine> collectComments(@NotNull
                                                                                          @NotNull Object value,
                                                                                          @NotNull
                                                                                          @NotNull String path,
                                                                                          @NotNull
                                                                                          @NotNull ConfigurationData configurationData,
                                                                                          int numberOfNewLines)

Creates comments based on all possible sources (number of empty lines, configuration data, ValueWithComments) and returns them as SnakeYAML comment lines.

Parameters:

value - the export value

path - the path the value is located at

configurationData - the configuration data instance

numberOfNewLines - number of new lines to add to the beginning of the comments

Returns:

comment lines representing all defined comments

getUsedUniqueCommentIds

@NotNull
protected final @NotNull Set<UUID> getUsedUniqueCommentIds()

Returns:

UUIDs of comments which should not be repeated that have already been included