ch.jalu.configme.configurationdata

Class PropertyListBuilder

java.lang.Object

ch.jalu.configme.configurationdata.PropertyListBuilder

public class PropertyListBuilder
extends Object

Builds a list of known properties in an ordered and grouped manner.

It guarantees that the added entries:

• are grouped by path, e.g. all "DataSource.mysql" properties are together, and "DataSource.mysql" properties are within the broader "DataSource" group.
• are ordered by insertion, e.g. if the first "DataSource" property is inserted before the first "security" property, then "DataSource" properties will come before the "security" ones.
• are unique: if any property is attempted to be added twice, or the addition of a property would remove another existing property, an exception is thrown

Constructor Summary

Constructors

Constructor and Description
PropertyListBuilder()

Method Summary

Modifier and Type	Method and Description
void	add(@NotNull Property<?> property) Adds the property to the list builder.
@NotNull List<Property<?>>	create() Creates a list of properties that have been added, by insertion order but grouped by path parents (see class JavaDoc).
protected @NotNull Map<String,Object>	getMapBeforeLastElement(String[] pathParts) Returns the nested map for the given path parts in which a property can be saved (for the last element in the path parts).
protected @NotNull Map<String,Object>	getRootEntries()
protected void	throwExceptionForMalformedPath(@NotNull String path)

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyListBuilder

public PropertyListBuilder()

Method Detail

add

public void add(@NotNull
                @NotNull Property<?> property)

Adds the property to the list builder.

Parameters:

property - the property to add

create

@NotNull
public @NotNull List<Property<?>> create()

Creates a list of properties that have been added, by insertion order but grouped by path parents (see class JavaDoc).

Returns:

ordered list of registered properties

getMapBeforeLastElement

@NotNull
protected @NotNull Map<String,Object> getMapBeforeLastElement(String[] pathParts)

Returns the nested map for the given path parts in which a property can be saved (for the last element in the path parts). Throws an exception if the path is malformed.

Parameters:

pathParts - the path elements (i.e. the property path split by ".")

Returns:

the map to store the property in

throwExceptionForMalformedPath

protected void throwExceptionForMalformedPath(@NotNull
                                              @NotNull String path)

getRootEntries

@NotNull
protected final @NotNull Map<String,Object> getRootEntries()