RestorableEnumN<T extends Enum> class

A RestorableProperty that knows how to store and restore a nullable Enum type.

The current value of this property is stored in the restoration data. During state restoration the property is restored to the value it had when the restoration data it is getting restored from was collected.

If no restoration data is available, value is initialized to the defaultValue given in the constructor.

The values are serialized using the name of the enum, obtained using the extension accessor.

The represented value is accessible via the value getter. The set of values in the enum are accessible via the values getter. Since RestorableEnumN allows null, this set will include null.

See also:

  • RestorableEnum, a class similar to this one that knows how to store and restore non-nullable Enum types.


RestorableEnumN(T? defaultValue, {required Iterable<T> values})
Creates a RestorableEnumN.


enabled bool
Whether the object currently returned by toPrimitives should be included in the restoration state.
hashCode int
The hash code for this object.
hasListeners bool
Whether any listeners are currently registered.
isRegistered bool
Whether this property is currently registered with a RestorationMixin.
runtimeType Type
A representation of the runtime type of the object.
state State<StatefulWidget>
The State object that this property is registered with.
value ↔ T?
The current value stored in this property.
read / writeinherited-getteroverride-setter
values Set<T>
The set of non-null values that this RestorableEnumN may represent.
read / write


addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
createDefaultValue() → T?
Called by the RestorationMixin if no restoration data is available to restore the value of the property from to obtain the default value for the property.
didUpdateValue(T? oldValue) → void
Called whenever a new value is assigned to value.
dispose() → void
Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to addListener will throw after the object is disposed).
fromPrimitives(Object? data) → T?
Called by the RestorationMixin to convert the data previously retrieved from toPrimitives back into an object of type T that this property should wrap.
initWithValue(T? value) → void
Called by the RestorationMixin with the value returned by either createDefaultValue or fromPrimitives to set the value that this property currently wraps.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
notifyListeners() → void
Call all the registered listeners.
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
toPrimitives() Object?
Called by the RestorationMixin to retrieve the information that this property wants to store in the restoration data.
toString() String
A string representation of this object.


operator ==(Object other) bool
The equality operator.