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

Property resource based on a YAML file.

Constructor Summary

Constructors

Constructor and Description
YamlFileResource(File file) Constructor.
YamlFileResource(File file, PropertyReader reader, LeafPropertiesGenerator leafPropertiesGenerator) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	contains(String path) Returns whether a value is present for the given path.
protected List<Property<?>>	convertPropertiesToExportableTypes(List<Property<?>> originalList) Converts the property entries to exportable "leaf" properties.
void	exportProperties(ConfigurationData configurationData) Exports the properties (e.g.
Boolean	getBoolean(String path) Returns the value of the given path as a boolean if available.
Double	getDouble(String path) Returns the value of the given path as a double if available.
Integer	getInt(String path) Returns the value of the given path as an integer if available.
List<?>	getList(String path) Returns the value of the given path as a list if available.
Object	getObject(String path) Returns the object at the given path, or null if absent.
protected org.yaml.snakeyaml.Yaml	getSimpleYaml() Returns a YAML instance set to export values with the default style.
protected org.yaml.snakeyaml.Yaml	getSingleQuoteYaml() Returns a YAML instance set to export values with single quotes.
String	getString(String path) Returns the value of the given path as a String if available.
void	reload() Reloads the configuration, e.g.
void	setValue(String path, Object value) Sets the value for the given path.
protected String	transformValue(Property<?> property, Object value) Returns the YAML representation for the given value (belonging to the given value).

Methods inherited from class java.lang.Object

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

Constructor Detail

YamlFileResource

public YamlFileResource(File file)

Constructor.

Parameters:

file - the config file

YamlFileResource

public YamlFileResource(File file,
                        PropertyReader reader,
                        LeafPropertiesGenerator leafPropertiesGenerator)

Constructor.

Parameters:

file - the config file (the YAML file to which properties get exported)

reader - the reader from which the properties' values are read

leafPropertiesGenerator - generator of property entries to export bean properties. Can be null only if you do not use bean properties.

Method Detail

getObject

public Object getObject(String path)

Description copied from interface: PropertyResource

Returns the object at the given path, or null if absent.

Specified by:

getObject in interface PropertyResource

Parameters:

path - the path to retrieve the value for

Returns:

the value, or null if there is none

getString

public String getString(String path)

Description copied from interface: PropertyResource

Returns the value of the given path as a String if available.

Specified by:

getString in interface PropertyResource

Parameters:

path - the path to retrieve a String for

Returns:

the value as a String, or null if not applicable or unavailable

getInt

public Integer getInt(String path)

Description copied from interface: PropertyResource

Returns the value of the given path as an integer if available.

Specified by:

getInt in interface PropertyResource

Parameters:

path - the path to retrieve an integer for

Returns:

the value as integer, or null if not applicable or unavailable

getDouble

public Double getDouble(String path)

Description copied from interface: PropertyResource

Returns the value of the given path as a double if available.

Specified by:

getDouble in interface PropertyResource

Parameters:

path - the path to retrieve a double for

Returns:

the value as a double, or null if not applicable or unavailable

getBoolean

public Boolean getBoolean(String path)

Description copied from interface: PropertyResource

Returns the value of the given path as a boolean if available.

Specified by:

getBoolean in interface PropertyResource

Parameters:

path - the path to retrieve a boolean for

Returns:

the value as a boolean, or null if not applicable or unavailable

getList

public List<?> getList(String path)

Description copied from interface: PropertyResource

Returns the value of the given path as a list if available.

Specified by:

getList in interface PropertyResource

Parameters:

path - the path to retrieve a list for

Returns:

the value as a list, or null if not applicable or unavailable

contains

public boolean contains(String path)

Description copied from interface: PropertyResource

Returns whether a value is present for the given path. When applicable, Property.isPresent(PropertyResource) should be favored over calling this method as it may make more type-aware checks. This method simply returns whether some value exists under the given path.

Specified by:

contains in interface PropertyResource

Parameters:

path - the path to check

Returns:

true if there is a value, false otherwise

setValue

public void setValue(String path,
                     Object value)

Description copied from interface: PropertyResource

Sets the value for the given path. Only modifies the in-memory collection of loaded values. New values are only persisted after PropertyResource.exportProperties(ConfigurationData) has been called.

Specified by:

setValue in interface PropertyResource

Parameters:

path - the path to set a new value for

value - the value to set

reload

public void reload()

Description copied from interface: PropertyResource

Reloads the configuration, e.g. from a file.

Specified by:

reload in interface PropertyResource

exportProperties

public void exportProperties(ConfigurationData configurationData)

Description copied from interface: PropertyResource

Exports the properties (e.g. writes to a file).

Specified by:

exportProperties in interface PropertyResource

Parameters:

configurationData - the configuration data

convertPropertiesToExportableTypes

protected List<Property<?>> convertPropertiesToExportableTypes(List<Property<?>> originalList)

Converts the property entries to exportable "leaf" properties.

Properties of type BeanProperty are converted to multiple Property objects that reflect all concrete values that need to be stored to properly, losslessly export the bean. The property entries are essentially the "leaf nodes" of the bean if viewed as a tree.

OptionalProperty instances are skipped if they evaluate to an empty value; otherwise, the Optional interface is stripped and the underlying property is used in the export.

Parameters:

originalList - the list of property entries to convert

Returns:

list of properties with converted property entries

transformValue

protected String transformValue(@Nullable
                                Property<?> property,
                                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:

property - the associated property

value - the value to transform as YAML

Returns:

the YAML representation of the value

getSimpleYaml

protected org.yaml.snakeyaml.Yaml getSimpleYaml()

Returns a YAML instance set to export values with the default style.

Returns:

YAML instance

getSingleQuoteYaml

protected org.yaml.snakeyaml.Yaml getSingleQuoteYaml()

Returns a YAML instance set to export values with single quotes.

Returns:

YAML instance