ch.jalu.configme.resource

Class YamlFileResource

java.lang.Object

ch.jalu.configme.resource.YamlFileResource

All Implemented Interfaces:

PropertyResource

public class YamlFileResource
extends Object
implements PropertyResource

Constructor Summary

Constructors

Constructor and Description
YamlFileResource(@NotNull File file) Deprecated. scheduled for removal
YamlFileResource(@NotNull Path path)
YamlFileResource(@NotNull Path path, @NotNull YamlFileResourceOptions options)

Method Summary

Modifier and Type	Method and Description
protected void	createAndAddYamlNode(@NotNull Object exportValue, @NotNull String path, @NotNull List<PropertyPathTraverser.PathElement> pathElements, @NotNull SnakeYamlNodeContainer rootContainer, @NotNull ConfigurationData configurationData, @NotNull SnakeYamlNodeBuilder nodeBuilder) Creates a YAML node for the export value and stores it, along with any comments for intermediate paths that have not been visited yet.
protected @NotNull org.yaml.snakeyaml.Yaml	createNewYaml() Creates a new SnakeYAML object with the appropriate options.
protected @NotNull SnakeYamlNodeBuilder	createNodeBuilder()
protected @NotNull SnakeYamlNodeContainer	createNodeContainerForRoot(@NotNull List<String> rootComments)
@NotNull PropertyReader	createReader() Creates a reader to access the values in the medium (typically a file).
void	exportProperties(@NotNull ConfigurationData configurationData) Exports the provided configuration data to the medium (typically a file).
protected @NotNull List<String>	getCommentsForPathElement(@NotNull ConfigurationData configurationData, @NotNull PropertyPathTraverser.PathElement pathElement)
protected @NotNull File	getFile() Deprecated.
protected @NotNull YamlFileResourceOptions	getOptions()
protected @NotNull Path	getPath()
protected @NotNull org.yaml.snakeyaml.Yaml	getYamlObject() Returns the YAML instance with which values are converted to YAML.
protected void	onWriteComplete() Called at the end of exportProperties(ch.jalu.configme.configurationdata.ConfigurationData), regardless whether the execution was successful or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

YamlFileResource

public YamlFileResource(@NotNull
                        @NotNull Path path)

YamlFileResource

public YamlFileResource(@NotNull
                        @NotNull Path path,
                        @NotNull
                        @NotNull YamlFileResourceOptions options)

YamlFileResource

@Deprecated
public YamlFileResource(@NotNull
                                    @NotNull File file)

Deprecated. scheduled for removal

Constructor (legacy). Prefer YamlFileResource(Path).

Parameters:

file - the file

Method Detail

createReader

@NotNull
public @NotNull PropertyReader createReader()

Description copied from interface: PropertyResource

Creates a reader to access the values in the medium (typically a file).

The reader is discarded after its use and so is not required to refresh itself.

Specified by:

createReader in interface PropertyResource

Returns:

reader providing values in the medium (e.g. file)

exportProperties

public void exportProperties(@NotNull
                             @NotNull ConfigurationData configurationData)

Description copied from interface: PropertyResource

Exports the provided configuration data to the medium (typically a file).

Specified by:

exportProperties in interface PropertyResource

Parameters:

configurationData - the configuration data to export

createAndAddYamlNode

protected void createAndAddYamlNode(@NotNull
                                    @NotNull Object exportValue,
                                    @NotNull
                                    @NotNull String path,
                                    @NotNull
                                    @NotNull List<PropertyPathTraverser.PathElement> pathElements,
                                    @NotNull
                                    @NotNull SnakeYamlNodeContainer rootContainer,
                                    @NotNull
                                    @NotNull ConfigurationData configurationData,
                                    @NotNull
                                    @NotNull SnakeYamlNodeBuilder nodeBuilder)

Creates a YAML node for the export value and stores it, along with any comments for intermediate paths that have not been visited yet.

Parameters:

exportValue - the export value to store

path - the path the export value is for

pathElements - the path elements of this property's path

rootContainer - the root YAML node container for storing the export value

configurationData - the configuration data (for the retrieval of comments)

nodeBuilder - YAML node builder

getCommentsForPathElement

@NotNull
protected @NotNull List<String> getCommentsForPathElement(@NotNull
                                                                   @NotNull ConfigurationData configurationData,
                                                                   @NotNull
                                                                   @NotNull PropertyPathTraverser.PathElement pathElement)

getPath

@NotNull
protected final @NotNull Path getPath()

getFile

@Deprecated
 @NotNull
protected final @NotNull File getFile()

Deprecated.

onWriteComplete

protected void onWriteComplete()

Called at the end of exportProperties(ch.jalu.configme.configurationdata.ConfigurationData), regardless whether the execution was successful or not.

getYamlObject

@NotNull
protected @NotNull org.yaml.snakeyaml.Yaml getYamlObject()

Returns the YAML instance with which values are converted to YAML.

Returns:

the YAML instance to use

createNewYaml

@NotNull
protected @NotNull org.yaml.snakeyaml.Yaml createNewYaml()

Creates a new SnakeYAML object with the appropriate options.

Returns:

the YAML instance for exporting values

getOptions

@NotNull
protected final @NotNull YamlFileResourceOptions getOptions()

createNodeBuilder

@NotNull
protected @NotNull SnakeYamlNodeBuilder createNodeBuilder()

createNodeContainerForRoot

@NotNull
protected @NotNull SnakeYamlNodeContainer createNodeContainerForRoot(@NotNull
                                                                              @NotNull List<String> rootComments)