ch.jalu.configme.resource.yaml

Interface SnakeYamlNodeContainer

All Known Implementing Classes:

SnakeYamlNodeContainerImpl

public interface SnakeYamlNodeContainer

Container that keeps SnakeYAML node objects in hierarchical order. Leaf values are SnakeYAML nodes, while parent values are containers that can be converted to SnakeYAML nodes representing all enclosed values.

Method Summary

Modifier and Type	Method and Description
@NotNull org.yaml.snakeyaml.nodes.Node	convertToNode(@NotNull SnakeYamlNodeBuilder nodeBuilder) Converts this container and its sub-containers, recursively, to a SnakeYAML node that represents all SnakeYAML nodes held by the containers.
@NotNull SnakeYamlNodeContainer	getOrCreateChildContainer(String name, Supplier<List<String>> commentsSupplier) Returns the existing container for the given name, or creates one and registers the comments as returned by the supplier.
@NotNull org.yaml.snakeyaml.nodes.Node	getRootValueNode() Returns the SnakeYAML node at the root path (empty string).
void	putNode(@NotNull String name, @NotNull org.yaml.snakeyaml.nodes.Node node) Saves the given node under the given name (= path element).

Method Detail

getOrCreateChildContainer

@NotNull
@NotNull SnakeYamlNodeContainer getOrCreateChildContainer(String name,
                                                                   Supplier<List<String>> commentsSupplier)

Returns the existing container for the given name, or creates one and registers the comments as returned by the supplier. An exception is thrown if a value (SnakeYAML node) was saved under the given name.

Parameters:

name - the path name to get

commentsSupplier - supplier with comments to set if the container has to be created

Returns:

container for the given path name

getRootValueNode

@NotNull
@NotNull org.yaml.snakeyaml.nodes.Node getRootValueNode()

Returns the SnakeYAML node at the root path (empty string). Used as root of the YAML document when the configuration only has one property at root path. Throws an exception if no value was stored for the root path.

Returns:

internal root node

putNode

void putNode(@NotNull
             @NotNull String name,
             @NotNull
             @NotNull org.yaml.snakeyaml.nodes.Node node)

Saves the given node under the given name (= path element). Throws an exception if a value is already associated with the given name.

Parameters:

name - the name to save the value under

node - the node to save

convertToNode

@NotNull
@NotNull org.yaml.snakeyaml.nodes.Node convertToNode(@NotNull
                                                              @NotNull SnakeYamlNodeBuilder nodeBuilder)

Converts this container and its sub-containers, recursively, to a SnakeYAML node that represents all SnakeYAML nodes held by the containers.

Parameters:

nodeBuilder - node builder to create nodes with

Returns:

this container's values as SnakeYAML node