soap_annotation library

Provides annotation classes to use with soap_serializable.

Also contains helper functions and classes – prefixed with $ used by soap_serializable when the use_wrappers or checked options are enabled.

Classes

SoapConverter<T, S>
Implement this class to provide custom converters for a specific Type. [...]
SoapKey
An annotation used to specify how a field is serialized.
SoapLiteral
An annotation used to generate a private field containing the contents of a SOAP file. [...]
SoapSerializable
An annotation used to specify a class to generate code for.
SoapValue
An annotation used to specify how a enum value is serialized.

Functions

$checkedConvert<T>(Map map, String key, T castFunc(Object value)) → T
Helper function used in generated code when SoapSerializableGenerator.checked is true. [...]
$checkedNew<T>(String className, Map map, T constructor(), {Map<String, String> fieldKeyMap}) → T
Helper function used in generated code when SoapSerializableGenerator.checked is true. [...]
$checkKeys(Map map, {List<String> allowedKeys, List<String> requiredKeys, List<String> disallowNullValues}) → void
Helper function used in generated fromSoap code when SoapSerializable.disallowUnrecognizedKeys is true for an annotated type or SoapKey.required is true for any annotated fields. [...]

Enums

FieldRename
Values for the automatic field renaming behavior for SoapSerializable.

Exceptions / Errors

BadKeyException
A base class for exceptions thrown when decoding SOAP.
CheckedFromSoapException
Exception thrown if there is a runtime exception in fromSoap code generated when SoapSerializableGenerator.checked is true
DisallowedNullValueException
Exception thrown if there are keys with disallowed null values in a SOAP map that was provided during deserialization.
MissingRequiredKeysException
Exception thrown if there are missing required keys in a SOAP map that was provided during deserialization.
UnrecognizedKeysException
Exception thrown if there are unrecognized keys in a SOAP map that was provided during deserialization.