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

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

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