ch.jalu.configme.resource.yaml

Interface SnakeYamlNodeBuilder

All Known Implementing Classes:

SnakeYamlNodeBuilderImpl

public interface SnakeYamlNodeBuilder

Creates SnakeYAML nodes for values and comments.

Method Summary

Modifier and Type	Method and Description
@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.
@NotNull org.yaml.snakeyaml.nodes.Node	createYamlNode(@NotNull Object value, @NotNull String path, @NotNull ConfigurationData configurationData, int numberOfNewLines) Creates a SnakeYAML node representing the given value.
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.

Method Detail

createYamlNode

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

Creates a SnakeYAML node representing the given value.

Parameters:

value - 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
@NotNull org.yaml.snakeyaml.nodes.Node createKeyNode(@NotNull
                                                              @NotNull String key)

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

Parameters:

key - the key to wrap into a node

Returns:

a node representing the key value

createCommentLines

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

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).

Parameters:

comment - the comment to represent as CommentLine

Returns:

stream with comment line objects representing the given comment

transferComments

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

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.

Parameters:

valueNode - the value node to remove the comments from

keyNode - the key node to set the comments to