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(File file) Deprecated. scheduled for removal
YamlFileResource(Path path)
YamlFileResource(Path path, YamlFileResourceOptions options)

Method Summary

Modifier and Type	Method and Description
protected List<String>	combinePathElementsAndMapEntryKey(List<String> parentPathElements, String mapEntryKey) Combines two path element sources to a new list of path elements: the list of path elements that were given from the parent context and the map entry key from which one or more path elements should be derived.
protected org.yaml.snakeyaml.Yaml	createNewYaml()
PropertyReader	createReader() Creates a reader to access the values in the medium (typically a file).
protected String	escapePathElementIfNeeded(String path)
void	exportProperties(ConfigurationData configurationData) Exports the provided configuration data to the medium (typically a file).
protected void	exportValue(Writer writer, PropertyPathTraverser pathTraverser, List<String> pathElements, Object value) Exports the given value at the provided path.
protected File	getFile() Deprecated.
protected YamlFileResourceOptions	getOptions()
protected Path	getPath()
protected org.yaml.snakeyaml.Yaml	getYamlObject() Returns the YAML instance with which values are converted to YAML.
protected String	indent(int level) Returns a String of whitespace for indentation in YAML at the given level.
protected void	onWriteComplete() Called at the end of exportProperties(ch.jalu.configme.configurationdata.ConfigurationData), regardless whether the execution was successful or not.
protected String	toYaml(Object value) Returns the YAML representation for the given value (belonging to the given value).
protected String	toYamlIndented(Object value, int indent) Returns the value in its YAML representation with an indentation of the given level.
protected void	writeComments(Writer writer, int indentation, PropertyPathTraverser.PathElement pathElement) Writes the given comment lines as YAML comments at the given indentation level.

Methods inherited from class java.lang.Object

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

Constructor Detail

YamlFileResource

public YamlFileResource(Path path)

YamlFileResource

public YamlFileResource(Path path,
                        YamlFileResourceOptions options)

YamlFileResource

@Deprecated
public YamlFileResource(File file)

Deprecated. scheduled for removal

Constructor (legacy). Prefer YamlFileResource(Path).

Parameters:

file - the file

Method Detail

createReader

public 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(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

getPath

protected final Path getPath()

getFile

@Deprecated
protected final File getFile()

Deprecated.

exportValue

protected void exportValue(Writer writer,
                           PropertyPathTraverser pathTraverser,
                           List<String> pathElements,
                           Object value)
                    throws IOException

Exports the given value at the provided path.

Parameters:

writer - the file writer to write with

pathTraverser - the path traverser (e.g. keeps track of which path elements are new)

pathElements - all elements that make up the path to the value

value - the value to export

Throws:

IOException - .

writeComments

protected void writeComments(Writer writer,
                             int indentation,
                             PropertyPathTraverser.PathElement pathElement)
                      throws IOException

Writes the given comment lines as YAML comments at the given indentation level.

Parameters:

writer - the writer to write with

indentation - the level at which the comment lines should be indented

pathElement - the path element for which the comments are being generated

Throws:

IOException - .

combinePathElementsAndMapEntryKey

protected List<String> combinePathElementsAndMapEntryKey(List<String> parentPathElements,
                                                         String mapEntryKey)

Combines two path element sources to a new list of path elements: the list of path elements that were given from the parent context and the map entry key from which one or more path elements should be derived.

Parameters:

parentPathElements - the path elements that were previously given

mapEntryKey - the key of a map entry which is added to the path

Returns:

path of the map entry based on previous elements and its key

toYamlIndented

protected String toYamlIndented(@Nullable
                                Object value,
                                int indent)

Returns the value in its YAML representation with an indentation of the given level. Proper indentation should be applied to all lines except for the first one (such that this method's return value can simply be appended to a properly indented property prefix like name:).

Parameters:

value - the value to convert to YAML

indent - level of indentation to use

Returns:

the value as YAML at the given indentation level

toYaml

protected String toYaml(@Nullable
                        Object value)

Returns the YAML representation for the given value (belonging to the given value). This method returns the YAML representation of the value only (does not include the key) with no indentation (will be applied afterwards with the appropriate level).

Parameters:

value - the value to transform as YAML

Returns:

the YAML representation of the value

indent

protected String indent(int level)

Returns a String of whitespace for indentation in YAML at the given level.

Parameters:

level - the desired level of indentation

Returns:

whitespace to prepend to a line for proper indentation

escapePathElementIfNeeded

protected String escapePathElementIfNeeded(String path)

onWriteComplete

protected void onWriteComplete()

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

getYamlObject

protected org.yaml.snakeyaml.Yaml getYamlObject()

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

Returns:

the YAML instance to use

createNewYaml

protected org.yaml.snakeyaml.Yaml createNewYaml()

getOptions

protected final YamlFileResourceOptions getOptions()