Package net.mezzdev.config.api.value.serializer

Interface IConfigListValueSerializer<T>

All Superinterfaces:

IConfigValueSerializer<List<T>>

public interface IConfigListValueSerializer<T>
extends IConfigValueSerializer<List<T>>

Describes a list whose elements config editors can validate, add, remove, or reorder individually.

Built-in list helpers already provide this metadata. Implement it for custom list validation or when declaring a list through IConfigCategoryBuilder.addValue(String, Object, IConfigValueSerializer). Element serializers may also implement IConfigKeyValueSerializer to present entries as editable key-value rows.

MezzConfig stores the list element-by-element with getElementSerializer(); the inherited container-level text representation is not used for structured file storage. Returned list values are unmodifiable snapshots, and their elements must follow the immutable value contract.

Since:

0.1.0

Method Summary

Modifier and Type	Method	Description
IConfigValueSerializer<T>	getElementSerializer()	Get the serializer config editors should use for individual elements.
default ConfigListOrdering	getOrdering()	Tell config editors whether reordering entries changes the setting's meaning.

Methods inherited from interface net.mezzdev.config.api.value.serializer.IConfigValueSerializer

deserialize, getAllValidValues, getRange, getValidValuesDescription, isValid, serialize

Method Details

getOrdering

default ConfigListOrdering getOrdering()

Tell config editors whether reordering entries changes the setting's meaning.

MezzConfig preserves the physical order in the config file either way. Integrations can use this metadata to decide whether reordering controls are useful.

Returns:

ordering semantics for this list

Since:

0.1.0

getElementSerializer

IConfigValueSerializer<T> getElementSerializer()

Get the serializer config editors should use for individual elements.

Since:

0.1.0