ClassDefinition class

A representation of a yaml file in the protocol directory defining a class or exception.

See also:

Inheritance

Constructors

ClassDefinition({required String moduleAlias, required String fileName, required String sourceFileName, required String className, required List<SerializableModelFieldDefinition> fields, required bool serverOnly, required bool manageMigration, required bool isException, String? tableName, List<SerializableModelIndexDefinition> indexes = const [], List<String> subDirParts = const [], List<String>? documentation})
Create a new ClassDefinition.

Properties

className → String
finalinherited
documentation → List<String>?
The documentation of this class, line by line.
final
fields ↔ List<SerializableModelFieldDefinition>
The fields of this class / exception.
getter/setter pair
fileName → String
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
indexes → List<SerializableModelIndexDefinition>
The indexes that should be created for the table tableName representing this class.
final
isException → bool
true if this is an exception and not a class.
final
manageMigration → bool
final
moduleAlias → String
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
serverOnly → bool
finalinherited
sourceFileName → String
finalinherited
subDirParts → List<String>
finalinherited
tableName → String?
If set, the name of the table, this class should be stored in, in the database.
final

Methods

fileRef() → String
Generate the file reference String to this file.
inherited
findField(String name) → SerializableModelFieldDefinition?
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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