squarealfa_entity_adapter library

Classes

AdaptedEntity
Annotation that instructs several code generators to generate added features to PODO classes.
AsciiCodec
An AsciiCodec allows encoding strings as ASCII bytes and decoding ASCII bytes to strings.
AsciiDecoder
Converts ASCII bytes to string.
AsciiEncoder
Converts strings of only ASCII characters to bytes.
Base64Codec
A base64 encoder and decoder.
Base64Decoder
Decoder for base64 encoded data.
Base64Encoder
Base64 and base64url encoding converter.
BuildBuilder
Annotation that instructs the code generator to build a subclass of BuildBuilder for the class to which it is applied
Builder<T>
BuildResult<T>
ByteConversionSink
The ByteConversionSink provides an interface for converters to efficiently transmit byte data.
ChunkedConversionSink<T>
A ChunkedConversionSink is used to transmit data more efficiently between two converters during chunked conversions.
ClosableStringSink
A ClosableStringSink extends the StringSink interface by adding a close method.
Codec<S, T>
A Codec encodes and (if supported) decodes data.
Converter<S, T>
A Converter converts data from one representation into another.
CopyWith
Annotation that instructs the code generator to build an extension of the class to which it is applied that adds a copyWith method
CrudPermissions
DefaultKeyHandler
DefaultsProvider
EmailAddress
Annotation that indicates the field to which it is applied to should be formatted as an email address
EmailAddressValidationError
Represents an error indicating that a required value is missing
Encoding
Open-ended set of encodings.
EntityAdapted
Annotation that instructs several code generators to generate added features to PODO classes.
EntityAdapter<TEntity>
Acts as a facade to the features that are added to PODOs
EntityPermissions
Defines the CRUD permissions for a PODO
ErrorList
Contains the results of a validation check
GServiceParameters<TServiceBase>
HtmlEscape
Converter which escapes characters with special meaning in HTML.
HtmlEscapeMode
HTML escape modes.
Int32
An immutable 32-bit signed integer, in the range -2^31, 2^31 - 1. Arithmetic operations may overflow in order to maintain this range.
Int64
An immutable 64-bit signed integer, in the range -2^63, 2^63 - 1. Arithmetic operations may overflow in order to maintain this range.
IntX
A fixed-precision integer.
JsonCodec
A JsonCodec encodes JSON objects to strings and decodes strings to JSON objects.
JsonDecoder
This class parses JSON strings and builds the corresponding objects.
JsonEncoder
This class converts JSON objects to strings.
JsonUtf8Encoder
Encoder that encodes a single object as a UTF-8 encoded JSON string.
KeyHandler
Latin1Codec
A Latin1Codec encodes strings to ISO Latin-1 (aka ISO-8859-1) bytes and decodes Latin-1 bytes to strings.
Latin1Decoder
This class converts Latin-1 bytes (lists of unsigned 8-bit integers) to a string.
Latin1Encoder
This class converts strings of only ISO Latin-1 characters to bytes.
LineSplitter
A StreamTransformer that splits a String into individual lines.
ListItemErrorList
Represents the validation errors, errorList, of an object item that is part of a list, list at the index itemIndex
ListPropertyValidation
Validation error applied to properties of List type, composed of multiple errors
MapField
When applied as an annotation to a field, indicates the code generator to map that field.
MapIgnore
When applied as an annotation to a field, indicates to the code generator to ignore that field.
MapMap
Annotate PODO class with MapMap in order to signal the code generator that it is to produce a map mapper for the class to which the annotation was applied.
MapMapped
Annotate PODO class with MapMap in order to signal the code generator that it is to produce a map mapper for the class to which the annotation was applied.
MapMapper<TEntity>
Converts instances of type TEntity to Map<String, dynamic> and from Map<String, dynamic> to TEntity
MapProto
MapProtoServices
PropertyValidation
Represents a ValidationError specific to a property that can contain multiple errors
Proto
ProtoField
ProtoIgnore
ProtoMapper<TEntity, TProto>
ProtoServices
Range<T>
Annotation that indicates the field to which it is applied to has a range of values between min and max
RangeValidationError<T>
Represents an error indicating that a required value is missing
RegularExpression
Annotation that indicates the field to which it is applied to has to math the given regular expression
RegularExpressionValidationError
Represents an error indicating that a required value is missing
Required
Annotation that indicates the field to which it is applied to is required
RequiredValidationError
Represents an error indicating that a required value is missing
StringConversionSink
A sink for converters to efficiently transmit String data.
StringLength
Annotation that indicates the field to which it is applied to has a length that ranges from minLength to maxLength
StringLengthValidationError
Represents an error indicating that a required value is missing
Utf8Codec
A Utf8Codec encodes strings to utf-8 code units (bytes) and decodes UTF-8 code units to strings.
Utf8Decoder
This class converts UTF-8 code units (lists of unsigned 8-bit integers) to a string.
Utf8Encoder
This class converts strings to their UTF-8 code units (a list of unsigned 8-bit integers).
Validatable
Annotation that indicates that the class to which it is applied to is a validatable class
ValidationError
Represents a validation error
Validator
Performs validation on an object

Constants

ascii → const AsciiCodec
An instance of the default implementation of the AsciiCodec.
base64 → const Base64Codec
A base64 encoder and decoder.
base64Url → const Base64Codec
A base64url encoder and decoder.
builder → const BuildBuilder
copyWith → const CopyWith
crudPermissions → const CrudPermissions
defaultsProvider → const DefaultsProvider
emailAddress → const EmailAddress
htmlEscape → const HtmlEscape
A String converter that converts characters to HTML entities.
json → const JsonCodec
An instance of the default implementation of the JsonCodec.
latin1 → const Latin1Codec
An instance of the default implementation of the Latin1Codec.
mapIgnore → const MapIgnore
mapMap → const MapMap
mapMapped → const MapMapped
mapProto → const MapProto
mapProtoServices → const MapProtoServices
proto → const Proto
protoField → const ProtoField
protoIgnore → const ProtoIgnore
protoServices → const ProtoServices
required → const Required
unicodeBomCharacterRune → const int
The Unicode Byte Order Marker (BOM) character U+FEFF.
unicodeReplacementCharacterRune → const int
The Unicode Replacement character U+FFFD (�).
utf8 → const Utf8Codec
An instance of the default implementation of the Utf8Codec.
validatable → const Validatable

Functions

base64Decode(String source) → Uint8List
Decodes base64 or base64url encoded bytes.
base64Encode(List<int> bytes) → String
Encodes bytes using base64 encoding.
base64UrlEncode(List<int> bytes) → String
Encodes bytes using base64url encoding.
jsonDecode(String source, {Object? reviver(Object? key, Object? value)?}) → dynamic
Parses the string and returns the resulting Json object.
jsonEncode(Object? object, {Object? toEncodable(Object? nonEncodable)?}) → String
Converts object to a JSON string.

Typedefs

ByteConversionSinkBase = ByteConversionSink
This class provides a base-class for converters that need to accept byte inputs.
StringConversionSinkBase = StringConversionSink
This class provides a base-class for converters that need to accept String inputs.
StringConversionSinkMixin = StringConversionSink
This class provides a mixin for converters that need to accept String inputs.

Exceptions / Errors

JsonCyclicError
Reports that an object could not be stringified due to cyclic references.
JsonUnsupportedObjectError
Error thrown by JSON serialization if an object cannot be serialized.