ch.jalu.configme.configurationdata

Class ConfigurationDataImpl

java.lang.Object

ch.jalu.configme.configurationdata.ConfigurationDataImpl

All Implemented Interfaces:

ConfigurationData

public class ConfigurationDataImpl
extends Object
implements ConfigurationData

Contains information about the available properties and their associated comments.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConfigurationDataImpl(List<? extends Property<?>> allProperties, Map<String,List<String>> allComments) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	areAllValuesValidInResource() Returns if the last call of ConfigurationData.initializeValues(ch.jalu.configme.resource.PropertyReader) had fully valid values in the resource for all known properties.
Map<String,List<String>>	getAllComments() Returns all comments registered to this configuration data.
List<String>	getCommentsForSection(String path) Returns the comments associated with the given path.
List<Property<?>>	getProperties() Returns all known properties.
<T> T	getValue(Property<T> property) Returns the value associated with the given property.
protected Map<String,Object>	getValues()
void	initializeValues(PropertyReader reader) Initializes the values of all known properties based on the provided reader.
<T> void	setValue(Property<T> property, T value) Sets the given value for the given property.
protected <T> boolean	setValueForProperty(Property<T> property, PropertyReader reader)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationDataImpl

protected ConfigurationDataImpl(List<? extends Property<?>> allProperties,
                                Map<String,List<String>> allComments)

Constructor. See also ConfigurationDataBuilder.

Parameters:

allProperties - all known properties

allComments - map of comments by path

Method Detail

getProperties

public List<Property<?>> getProperties()

Description copied from interface: ConfigurationData

Returns all known properties. The order of the properties is relevant and the export should respect it. For YAML it is important that properties with a common path be together (see PropertyListBuilder for more details).

Specified by:

getProperties in interface ConfigurationData

Returns:

list of properties, in order

getCommentsForSection

public List<String> getCommentsForSection(String path)

Description copied from interface: ConfigurationData

Returns the comments associated with the given path.

Specified by:

getCommentsForSection in interface ConfigurationData

Parameters:

path - the path for which the comments should be retrieved

Returns:

list of comments, never null

getAllComments

public Map<String,List<String>> getAllComments()

Description copied from interface: ConfigurationData

Returns all comments registered to this configuration data. Typically for tests and debugging only. Use ConfigurationData.getCommentsForSection(String) if you are not interested in the entirety of comments.

Specified by:

getAllComments in interface ConfigurationData

Returns:

read-only view of all comments

getValue

public <T> T getValue(Property<T> property)

Description copied from interface: ConfigurationData

Returns the value associated with the given property. Only to be used with properties contained in ConfigurationData.getProperties(). By default, never returns null (since base properties always resolve to a non-null value) and throws an exception if the property is unknown.

Specified by:

getValue in interface ConfigurationData

Type Parameters:

T - property type

Parameters:

property - the property to look up

Returns:

value associated with the property, or null if not present

setValue

public <T> void setValue(Property<T> property,
                         T value)

Description copied from interface: ConfigurationData

Sets the given value for the given property. May throw an exception if the value is not valid.

Specified by:

setValue in interface ConfigurationData

Type Parameters:

T - the property type

Parameters:

property - the property to change the value for

value - the value to set

initializeValues

public void initializeValues(PropertyReader reader)

Description copied from interface: ConfigurationData

Initializes the values of all known properties based on the provided reader. Clears any already existing values.

Specified by:

initializeValues in interface ConfigurationData

Parameters:

reader - the reader to use to determine the property's values

setValueForProperty

protected <T> boolean setValueForProperty(Property<T> property,
                                          PropertyReader reader)

areAllValuesValidInResource

public boolean areAllValuesValidInResource()

Description copied from interface: ConfigurationData

Returns if the last call of ConfigurationData.initializeValues(ch.jalu.configme.resource.PropertyReader) had fully valid values in the resource for all known properties. If false, at least one property was either not present in the resource, or the data under its path was not fully acceptable for the property type. Returns false if the properties have not yet been loaded.

Specified by:

areAllValuesValidInResource in interface ConfigurationData

Returns:

true if all properties are represented in a fully valid way in the resource, false otherwise

See Also:

PropertyValue.isValidInResource()

getValues

protected Map<String,Object> getValues()