open-project-flutter-api/lib/model/work_package_model_description.dart

//
// AUTO-GENERATED FILE, DO NOT MODIFY!
//
// @dart=2.12

// ignore_for_file: unused_element, unused_import
// ignore_for_file: always_put_required_named_parameters_first
// ignore_for_file: constant_identifier_names
// ignore_for_file: lines_longer_than_80_chars

part of openapi.api;

class WorkPackageModelDescription {
  /// Returns a new [WorkPackageModelDescription] instance.
  WorkPackageModelDescription({
    required this.format,
    this.raw,
    this.html,
  });

  /// Indicates the formatting language of the raw text
  WorkPackageModelDescriptionFormatEnum format;

  /// The raw text, as entered by the user
  ///
  /// Please note: This property should have been non-nullable! Since the specification file
  /// does not include a default value (using the "default:" property), however, the generated
  /// source code must fall back to having a nullable type.
  /// Consider adding a "default:" property in the specification file to hide this note.
  ///
  String? raw;

  /// The text converted to HTML according to the format
  ///
  /// Please note: This property should have been non-nullable! Since the specification file
  /// does not include a default value (using the "default:" property), however, the generated
  /// source code must fall back to having a nullable type.
  /// Consider adding a "default:" property in the specification file to hide this note.
  ///
  String? html;

  @override
  bool operator ==(Object other) => identical(this, other) || other is WorkPackageModelDescription &&
    other.format == format &&
    other.raw == raw &&
    other.html == html;

  @override
  int get hashCode =>
    // ignore: unnecessary_parenthesis
    (format.hashCode) +
    (raw == null ? 0 : raw!.hashCode) +
    (html == null ? 0 : html!.hashCode);

  @override
  String toString() => 'WorkPackageModelDescription[format=$format, raw=$raw, html=$html]';

  Map<String, dynamic> toJson() {
    final json = <String, dynamic>{};
      json[r'format'] = this.format;
    if (this.raw != null) {
      json[r'raw'] = this.raw;
    } else {
      json[r'raw'] = null;
    }
    if (this.html != null) {
      json[r'html'] = this.html;
    } else {
      json[r'html'] = null;
    }
    return json;
  }

  /// Returns a new [WorkPackageModelDescription] instance and imports its values from
  /// [value] if it's a [Map], null otherwise.
  // ignore: prefer_constructors_over_static_methods
  static WorkPackageModelDescription? fromJson(dynamic value) {
    if (value is Map) {
      final json = value.cast<String, dynamic>();

      // Ensure that the map contains the required keys.
      // Note 1: the values aren't checked for validity beyond being non-null.
      // Note 2: this code is stripped in release mode!
      assert(() {
        requiredKeys.forEach((key) {
          assert(json.containsKey(key), 'Required key "WorkPackageModelDescription[$key]" is missing from JSON.');
          assert(json[key] != null, 'Required key "WorkPackageModelDescription[$key]" has a null value in JSON.');
        });
        return true;
      }());

      return WorkPackageModelDescription(
        format: WorkPackageModelDescriptionFormatEnum.fromJson(json[r'format'])!,
        raw: mapValueOfType<String>(json, r'raw'),
        html: mapValueOfType<String>(json, r'html'),
      );
    }
    return null;
  }

  static List<WorkPackageModelDescription> listFromJson(dynamic json, {bool growable = false,}) {
    final result = <WorkPackageModelDescription>[];
    if (json is List && json.isNotEmpty) {
      for (final row in json) {
        final value = WorkPackageModelDescription.fromJson(row);
        if (value != null) {
          result.add(value);
        }
      }
    }
    return result.toList(growable: growable);
  }

  static Map<String, WorkPackageModelDescription> mapFromJson(dynamic json) {
    final map = <String, WorkPackageModelDescription>{};
    if (json is Map && json.isNotEmpty) {
      json = json.cast<String, dynamic>(); // ignore: parameter_assignments
      for (final entry in json.entries) {
        final value = WorkPackageModelDescription.fromJson(entry.value);
        if (value != null) {
          map[entry.key] = value;
        }
      }
    }
    return map;
  }

  // maps a json object with a list of WorkPackageModelDescription-objects as value to a dart map
  static Map<String, List<WorkPackageModelDescription>> mapListFromJson(dynamic json, {bool growable = false,}) {
    final map = <String, List<WorkPackageModelDescription>>{};
    if (json is Map && json.isNotEmpty) {
      // ignore: parameter_assignments
      json = json.cast<String, dynamic>();
      for (final entry in json.entries) {
        map[entry.key] = WorkPackageModelDescription.listFromJson(entry.value, growable: growable,);
      }
    }
    return map;
  }

  /// The list of required keys that must be present in a JSON.
  static const requiredKeys = <String>{
    'format',
  };
}

/// Indicates the formatting language of the raw text
class WorkPackageModelDescriptionFormatEnum {
  /// Instantiate a new enum with the provided [value].
  const WorkPackageModelDescriptionFormatEnum._(this.value);

  /// The underlying value of this enum member.
  final String value;

  @override
  String toString() => value;

  String toJson() => value;

  static const plain = WorkPackageModelDescriptionFormatEnum._(r'plain');
  static const markdown = WorkPackageModelDescriptionFormatEnum._(r'markdown');
  static const custom = WorkPackageModelDescriptionFormatEnum._(r'custom');

  /// List of all possible values in this [enum][WorkPackageModelDescriptionFormatEnum].
  static const values = <WorkPackageModelDescriptionFormatEnum>[
    plain,
    markdown,
    custom,
  ];

  static WorkPackageModelDescriptionFormatEnum? fromJson(dynamic value) => WorkPackageModelDescriptionFormatEnumTypeTransformer().decode(value);

  static List<WorkPackageModelDescriptionFormatEnum> listFromJson(dynamic json, {bool growable = false,}) {
    final result = <WorkPackageModelDescriptionFormatEnum>[];
    if (json is List && json.isNotEmpty) {
      for (final row in json) {
        final value = WorkPackageModelDescriptionFormatEnum.fromJson(row);
        if (value != null) {
          result.add(value);
        }
      }
    }
    return result.toList(growable: growable);
  }
}

/// Transformation class that can [encode] an instance of [WorkPackageModelDescriptionFormatEnum] to String,
/// and [decode] dynamic data back to [WorkPackageModelDescriptionFormatEnum].
class WorkPackageModelDescriptionFormatEnumTypeTransformer {
  factory WorkPackageModelDescriptionFormatEnumTypeTransformer() => _instance ??= const WorkPackageModelDescriptionFormatEnumTypeTransformer._();

  const WorkPackageModelDescriptionFormatEnumTypeTransformer._();

  String encode(WorkPackageModelDescriptionFormatEnum data) => data.value;

  /// Decodes a [dynamic value][data] to a WorkPackageModelDescriptionFormatEnum.
  ///
  /// If [allowNull] is true and the [dynamic value][data] cannot be decoded successfully,
  /// then null is returned. However, if [allowNull] is false and the [dynamic value][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.
  WorkPackageModelDescriptionFormatEnum? decode(dynamic data, {bool allowNull = true}) {
    if (data != null) {
      switch (data) {
        case r'plain': return WorkPackageModelDescriptionFormatEnum.plain;
        case r'markdown': return WorkPackageModelDescriptionFormatEnum.markdown;
        case r'custom': return WorkPackageModelDescriptionFormatEnum.custom;
        default:
          if (!allowNull) {
            throw ArgumentError('Unknown enum value to decode: $data');
          }
      }
    }
    return null;
  }

  /// Singleton [WorkPackageModelDescriptionFormatEnumTypeTransformer] instance.
  static WorkPackageModelDescriptionFormatEnumTypeTransformer? _instance;
}