JsonKey class
An annotation used to specify how a field is serialized.
- Annotations
-
- @Target({TargetKind.field, TargetKind.getter})
Constructors
- JsonKey({@Deprecated('Has no effect') bool? nullable, Object? defaultValue, bool? disallowNullValue, Function? fromJson, @Deprecated('Use `includeFromJson` and `includeToJson` with a value of `false` ' 'instead.') bool? ignore, bool? includeFromJson, bool? includeIfNull, bool? includeToJson, String? name, Object? readValue(Map, String)?, bool? required, Function? toJson, Enum? unknownEnumValue})
-
Creates a new JsonKey instance.
const
Properties
- defaultValue → Object?
-
The value to use if the source JSON does not contain this key or if the
value is
null.final - disallowNullValue → bool?
-
If
true, generated code will throw a DisallowedNullValueException if the corresponding key exists, but the value isnull.final - fromJson → Function?
-
A Function to use when decoding the associated JSON value to the
annotated field.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- ignore → bool?
-
trueif the generator should ignore this field completely.final - includeFromJson → bool?
-
Used to force a field to be included (or excluded) when decoding a object
from JSON.
final
- includeIfNull → bool?
-
Whether the generator should include fields with
nullvalues in the serialized output.final - includeToJson → bool?
-
Used to force a field to be included (or excluded) when encoding a object
to JSON.
final
- name → String?
-
The key in a JSON map to use when reading and writing values corresponding
to the annotated fields.
final
- readValue → Object? Function(Map, String)?
-
Specialize how a value is read from the source JSON map.
final
- required → bool?
-
When
true, generated code forfromJsonwill verify that the source JSON map contains the associated key.final - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- toJson → Function?
-
A Function to use when encoding the annotated field to JSON.
final
- unknownEnumValue → Enum?
-
The value to use for an enum field when the value provided is not in the
source enum.
final
Methods
-
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
Constants
- nullForUndefinedEnumValue → const Enum
- Sentinel value for use with unknownEnumValue.