A base class for classes that describe aspects of a Scheme.
Every derived class has two common properties defined here: the version of the description the class provides and the name of that description. Changes to these and other properties in a derived class are reflected in a JSON value returned by the toDefinition method. These JSON values are used by the library to track Scheme changes in order to automatically trigger a scheme migration. See SearchIndex.getters for an exception to the automatic tracking that requires a manual increase of version.
- Implementers
- Annotations
-
- @immutable
Constructors
- SchemeElement({required int version, required String name})
-
Creates a SchemeElement initialized with the given
versionandname.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- lcName → String
-
The lowercase variant of name.
final
- name → String
-
A string representing the name of the provided description.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- version → int
-
An integer representing the version of the provided description.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDefinition(
) → Map< String, Object> - Returns a JSON that changes when SchemeElement properties change.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited