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(@NotNull List<? extends Property<?>> allProperties, @NotNull 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.
@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.
protected @NotNull Map<String,Object>	getValues()
void	initializeValues(@NotNull PropertyReader reader) 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.
protected <T> boolean	setValueForProperty(@NotNull Property<T> property, @NotNull 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(@NotNull
                                @NotNull List<? extends Property<?>> allProperties,
                                @NotNull
                                @NotNull Map<String,List<String>> allComments)

Constructor. See also ConfigurationDataBuilder.

Parameters:

allProperties - all known properties

allComments - map of comments by path

Method Detail

getProperties

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

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

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

Specified by:

getAllComments in interface ConfigurationData

Returns:

read-only view of all comments

getValue

@NotNull
public <T> T getValue(@NotNull
                               @NotNull 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(). 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

setValue

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

@NotNull
protected @NotNull Map<String,Object> getValues()