ch.jalu.configme.configurationdata

Interface ConfigurationData

All Known Implementing Classes:

ConfigurationDataImpl

public interface ConfigurationData

Manages configuration data:

• knows all available properties
• keeps all comments
• manages the values associated with the properties

Create instances with ConfigurationDataBuilder.

Method Summary

Modifier and Type	Method and Description
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.
void	initializeValues(PropertyReader propertyReader) 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.

Method Detail

getProperties

List<Property<?>> getProperties()

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).

Returns:

list of properties, in order

getCommentsForSection

List<String> getCommentsForSection(String path)

Returns the comments associated with the given path.

Parameters:

path - the path for which the comments should be retrieved

Returns:

list of comments, never null

getAllComments

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

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

Returns:

read-only view of all comments

initializeValues

void initializeValues(PropertyReader propertyReader)

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

Parameters:

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

getValue

@Nullable
<T> T getValue(Property<T> property)

Returns the value associated with the given property. Only to be used with properties contained in getProperties().

Type Parameters:

T - property type

Parameters:

property - the property to look up

Returns:

value associated with the property, or null if not present

setValue

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

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

Type Parameters:

T - the property type

Parameters:

property - the property to change the value for

value - the value to set