ch.jalu.configme.resource.yaml

Class SnakeYamlNodeContainerImpl

java.lang.Object

ch.jalu.configme.resource.yaml.SnakeYamlNodeContainerImpl

All Implemented Interfaces:

SnakeYamlNodeContainer

public class SnakeYamlNodeContainerImpl
extends Object
implements SnakeYamlNodeContainer

Implementation of SnakeYamlNodeContainer.

Constructor Summary

Constructors

Constructor and Description
SnakeYamlNodeContainerImpl(@NotNull List<String> comments)

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.
protected org.yaml.snakeyaml.nodes.Node	createRootNode(List<org.yaml.snakeyaml.nodes.NodeTuple> entryNodes)
protected List<String>	getComments()
@NotNull SnakeYamlNodeContainer	getOrCreateChildContainer(@NotNull String name, @NotNull 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).
protected Map<String,Object>	getValues()
void	putNode(@NotNull String name, @NotNull org.yaml.snakeyaml.nodes.Node node) Saves the given node under the given name (= path element).

Methods inherited from class java.lang.Object

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

Constructor Detail

SnakeYamlNodeContainerImpl

public SnakeYamlNodeContainerImpl(@NotNull
                                  @NotNull List<String> comments)

Method Detail

getOrCreateChildContainer

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

Description copied from interface: SnakeYamlNodeContainer

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.

Specified by:

getOrCreateChildContainer in interface SnakeYamlNodeContainer

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
public @NotNull org.yaml.snakeyaml.nodes.Node getRootValueNode()

Description copied from interface: SnakeYamlNodeContainer

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.

Specified by:

getRootValueNode in interface SnakeYamlNodeContainer

Returns:

internal root node

putNode

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

Description copied from interface: SnakeYamlNodeContainer

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

Specified by:

putNode in interface SnakeYamlNodeContainer

Parameters:

name - the name to save the value under

node - the node to save

convertToNode

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

Description copied from interface: SnakeYamlNodeContainer

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

Specified by:

convertToNode in interface SnakeYamlNodeContainer

Parameters:

nodeBuilder - node builder to create nodes with

Returns:

this container's values as SnakeYAML node

createRootNode

protected org.yaml.snakeyaml.nodes.Node createRootNode(List<org.yaml.snakeyaml.nodes.NodeTuple> entryNodes)

getComments

protected final List<String> getComments()

getValues

protected final Map<String,Object> getValues()