ch.jalu.configme.properties

Class MapProperty<V>

java.lang.Object

ch.jalu.configme.properties.BaseProperty<Map<String,V>>

ch.jalu.configme.properties.MapProperty<V>

Type Parameters:

V - the value type of the map

All Implemented Interfaces:

Property<Map<String,V>>

public class MapProperty<V>
extends BaseProperty<Map<String,V>>

Property for an immutable map whose keys is of type String and whose values can be configured. The map retains the order of the elements.

Constructor Summary

Constructors

Constructor and Description
MapProperty(@NotNull String path, @NotNull Map<String,V> defaultValue, @NotNull PropertyType<V> type) Constructor.

Method Summary

Modifier and Type	Method and Description
protected @Nullable Map<String,V>	getFromReader(@NotNull PropertyReader reader, @NotNull ConvertErrorRecorder errorRecorder) Constructs the value of the property from the property reader.
protected @NotNull Map<String,V>	postProcessMap(@NotNull Map<String,V> constructedMap)
@NotNull Object	toExportValue(@NotNull Map<String,V> value) Converts the given value to a representation that is suitable for exporting by a property resource.

Methods inherited from class ch.jalu.configme.properties.BaseProperty

determineValue, getDefaultValue, getPath, isValidValue, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.jalu.configme.properties.Property

isValidInResource

Constructor Detail

MapProperty

public MapProperty(@NotNull
                   @NotNull String path,
                   @NotNull
                   @NotNull Map<String,V> defaultValue,
                   @NotNull
                   @NotNull PropertyType<V> type)

Constructor.

Parameters:

path - the path of the property

defaultValue - the default value of the property

type - the property type of the values

Method Detail

getFromReader

@Nullable
protected @Nullable Map<String,V> getFromReader(@NotNull
                                                          @NotNull PropertyReader reader,
                                                          @NotNull
                                                          @NotNull ConvertErrorRecorder errorRecorder)

Description copied from class: BaseProperty

Constructs the value of the property from the property reader. Returns null if no value is available in the reader or if it cannot be used to construct a value for this property.

Specified by:

getFromReader in class BaseProperty<Map<String,V>>

Parameters:

reader - the reader to read from

errorRecorder - error recorder to register errors even if a valid value is returned

Returns:

value based on the reader, or null if not applicable

toExportValue

@NotNull
public @NotNull Object toExportValue(@NotNull
                                              @NotNull Map<String,V> value)

Description copied from interface: Property

Converts the given value to a representation that is suitable for exporting by a property resource. The return value should contain the data in the given value represented with only basic types (String, Number, Boolean), as well as lists and maps thereof.

The values which are suitable for returning depend on the support of the used property resource. By default, the supported types include null, String, Integer, Double, Boolean; Collection of the aforementioned types; Map with String keys and values of any of the aforementioned types. Maps and collections can be nested at any arbitrary level. Null signifies that the property/value should be skipped in the export.

Parameters:

value - the value to convert to an export value

Returns:

value to use for export, null to skip the property

postProcessMap

@NotNull
protected @NotNull Map<String,V> postProcessMap(@NotNull
                                                         @NotNull Map<String,V> constructedMap)