IConfiguratorEnum

Description

interface Tinman.Core.Config.Binding.IConfiguratorEnum → <T>

Derived from: IConfigurator<T>
Extended by: ConfiguratorEnum ^sealed

A IConfigurator for enumerated values.

Public / Methods

DefaultItem

public method DefaultItem → (3)

name ⁱⁿ : string: [not-empty]
The enum item name.
value ⁱⁿ : T: The enum item value.
tag ^opt : string = null: Optional enum item string tag.

Adds an enum item as the default item.

Finish

public method Finish → (2)

sort ^opt : bool = false: Sort enum items by their name?
defaultFirst ^opt : bool = false: Place default item first?
returns → IConfiguratorEnum<T>: this

Finishes building of this enum configurator.

ConfigException: If the enum type specification in invalid.

Flags

public method Flags → (1)

handler ⁱⁿ : IFlags<T>: [not-null]
The flag semantic.
returns → IConfigurator<T>: The resulting configurator.

Applies the given flag semantic to this configurator.

This configurator must be finished first.

Item

public method Item → (3)

name ⁱⁿ : string: [not-empty]
The enum item name.
value ⁱⁿ : T: The enum item value.
tag ^opt : string = null: Optional enum item string tag.

Adds an enum item.