decode method

GiftCardDeliveryStatusEnum? decode(
  1. dynamic data, {
  2. bool allowNull = true,
})

Returns the instance of GiftCardDeliveryStatusEnum that was successfully decoded from the passed data value on success, null otherwise.

If allowNull is true and the data cannot be decoded successfully, then null is returned. However, if allowNull is false and the data cannot be decoded successfully, then an UnimplementedError is thrown.

The allowNull is very handy when an API changes and a new enum value is added or removed, and users are still using an old app with the old code.

Implementation

GiftCardDeliveryStatusEnum? decode(dynamic data, {bool allowNull = true}) {
  if (data is GiftCardDeliveryStatusEnum) {
    return data;
  }
  if (data != null) {
    switch (data) {
      case r'pending': return GiftCardDeliveryStatusEnum.pending;
      case r'processing': return GiftCardDeliveryStatusEnum.processing;
      case r'retry': return GiftCardDeliveryStatusEnum.retry;
      case r'sent': return GiftCardDeliveryStatusEnum.sent;
      case r'failed': return GiftCardDeliveryStatusEnum.failed;
      default:
        if (!allowNull) {
          throw ArgumentError('Unknown enum value to decode: $data');
        }
    }
  }
  return null;
}