Interface IConfigValueEditorMetadata<T>

Type Parameters:

T - the value type

All Superinterfaces:

IConfigValueLocalizationProvider<T>

All Known Subinterfaces:

IConfigListValueEditorMetadata<T>, IConfigRangeValueEditorMetadata<T>

public interface IConfigValueEditorMetadata<T>
extends IConfigValueLocalizationProvider<T>

Editor selection, validation, and localized text for values edited by a config screen.

Since:

0.6.0

Method Summary

Modifier and Type	Method	Description
Optional<List<T>>	getAllValidValues()	Get the available choices when the value has a finite set of valid options.
ConfigValueEditorType<T>	getEditorType()	Get the kind of editor used for this value.
boolean	isValid(T value)	Check whether a proposed value can be applied.

Methods inherited from interface IConfigValueLocalizationProvider

getLocalizedValueDescription, getLocalizedValueName

Method Details

getEditorType

ConfigValueEditorType<T> getEditorType()

Get the kind of editor used for this value.

Since:

0.6.0

isValid

boolean isValid(T value)

Check whether a proposed value can be applied.

Since:

0.6.0

getAllValidValues

Optional<List<T>> getAllValidValues()

Get the available choices when the value has a finite set of valid options.

Returns:

the valid options, or empty when they cannot be enumerated

Since:

0.6.0