GraphqlSerialize class

Generate a function to produce a ClassElement from GraphQL data

Inheritance

• Object
• JsonSerdesGenerator<GraphqlModel, Graphql>
• GraphqlSerialize

Mixed-in types

• JsonSerialize<GraphqlModel, Graphql>

Constructors

GraphqlSerialize(ClassElement element, GraphqlFields fields, {required String repositoryName})

Properties

adapterMethod → String

The method as printed by the adapter. Does not include semicolon.

no setter, inherited

adapterMethodInputType → String

The expected input type for the adapterMethod

no setter, inherited

adapterMethodOutputType → String

The expected output type of the adapterMethod

no setter, inherited

className → String

no setter, inherited

constructorName → String

Discover factories within the class that rely on the provider. For example factory User.fromRest

no setter, inherited

deserializeInputType → String

The Type expected from the provider when deserializing

no setter, inherited

doesDeserialize → bool

Whether this generator serializes or deserializes raw input

final, inherited

element → ClassElement

The annotated class

final, inherited

fields → FieldsForClass<Graphql>

The sorted fields of the element

final, inherited

fieldsForGenerator → String

Mash the element's fields into a list for serialization or deserialization

no setter, inherited

generateSuffix → String

Code to follow after a class has been instantiated. Must end with semicolon.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

instanceFieldsAndMethods → List<String>

Any instance fields that should be copied to the adapter. Should terminate in ; if required.

no setter

providerName → String

For example, Rest or Sqlite

final, inherited

repositoryHasBeenForceCast ↔ bool

Avoid linter error on subsequent passes for the repository. For example, if repository has already been casted to ! it should not be recast

getter/setter pair, inherited

repositoryName → String

For example, OfflineFirst

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

serializeMethod → String

Discover serializers within the class that rely on the provider. For example toRest() =>

no setter, inherited

serializeOutputType → String

The Type expected by the provider when serializing

no setter, inherited

serializingFunctionArguments → String

Expected arguments for the serializing/deserializing function. Does not include parentheses.

no setter, inherited

serializingFunctionName → String

The generated deserialize function name

no setter, inherited

unignoredFields → Iterable<FieldElement>

All fields that are serializable by this generator and are not declared to be ignored by an annotation.

no setter

Methods

addField(FieldElement field, Graphql fieldAnnotation) → String?

Given each field, determine whether it can be added to the serdes function and, more importantly, determine how it should be added. If the field should not be added, return null.

inherited

checkerForField(FieldElement field) → SharedChecker<Model>

Return a SharedChecker for a type via the corresponding parameter in the constructor.

inherited

checkerForType(DartType type) → SharedChecker<Model>

Return a SharedChecker for a type. If including a custom checker in your domain, overwrite this field

inherited

coderForField(FieldElement field, SharedChecker<Model> checker, {required bool wrappedInFuture, required Graphql fieldAnnotation}) → String?

Produces serializing or deserializing method given a field and checker.

inherited

deserializerNullableClause({required FieldElement field, required Graphql fieldAnnotation, required String name}) → String

Injected between the field member in the constructor and the contents

inherited

digestPlaceholders(String? input, String annotatedName, String fieldName) → String?

Replace default placeholders

inherited

expandGenerators(Graphql annotation, {required FieldElement field, required SharedChecker<Model> checker}) → String?

Convert placeholders in fromGenerator and toGenerator to functions.

inherited

generate() → String

Wraps fieldsForGenerator in a method to produce serialization or deserialization

inherited

generateGraphqlDefinition(FieldElement field) → String

getAssociationMethod(DartType argType, {bool forceNullable = false, required String query}) → String

inherited

hasConstructor(DartType type) → bool

If this class possesses a factory such as fromRest

inherited

hasSerializer(DartType type) → bool

If this class possesses a serializing method such as toSqlite

inherited

ignoreCoderForField(FieldElement field, Graphql annotation, SharedChecker<Model> checker) → bool

Determine whether this field should be included in generated output.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

providerNameForField(String? annotatedName, {required SharedChecker<Model> checker}) → String

The field's name when being serialized to a provider. Optionally, a checker can reveal the field's purpose.

inherited

serdesValueForField(FieldElement field, String annotatedName, {required SharedChecker<Model> checker}) → String

The field's value when used by the generator. For example, data['my_field'] when used by a deserializing generator or instance.myField when used by a serializing generator

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited