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
boolean	areAllValuesValidInResource() Returns if the last call of initializeValues(ch.jalu.configme.resource.PropertyReader) had fully valid values in the resource for all known properties.
@NotNull Map<String,List<String>>	getAllComments() Returns all comments registered to this configuration data.
@NotNull List<String>	getCommentsForSection(String path) Returns the comments associated with the given path.
@NotNull List<Property<?>>	getProperties() Returns all known properties.
<T> T	getValue(@NotNull Property<T> property) Returns the value associated with the given property.
void	initializeValues(@NotNull PropertyReader propertyReader) Initializes the values of all known properties based on the provided reader.
<T> void	setValue(@NotNull Property<T> property, T value) Sets the given value for the given property.

Method Detail

getProperties

@NotNull
@NotNull 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

@NotNull
@NotNull 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

@NotNull
@NotNull 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 the comments.

Returns:

read-only view of all comments

initializeValues

void initializeValues(@NotNull
                      @NotNull 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

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

Returns the value associated with the given property. Only to be used with properties contained in getProperties(). Throws an exception if the property is unknown.

Type Parameters:

T - property type

Parameters:

property - the property to look up

Returns:

value associated with the property

setValue

<T> void setValue(@NotNull
                  @NotNull Property<T> property,
                  @NotNull
                  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

areAllValuesValidInResource

boolean areAllValuesValidInResource()

Returns if the last call of 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.

Returns:

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

See Also:

PropertyValue.isValidInResource()