rougelike_LeiXiXueGui/Assets/TotalJSON/Scripts/Settings/DeserializeSettings.cs

//  DeserializeSettings


namespace Leguar.TotalJSON {
	
	/// <summary>
	/// Settings for deserialization.
	/// </summary>
	public class DeserializeSettings {

		private bool allowFieldsToBeObjects = false;

		/// <summary>
		/// By default this is false. Meaning that any fields where values are deserialized need to be exactly same type as JSON object. For example JBoolean goes only to
		/// bool, JString goes only to string, JSON goes only to Dictionary etc.
		/// 
		/// If this is set true, deserialization allows target fields also to be just objects (System.Object). Note however that in some cases deserialization may need to
		/// "guess" the correct type, for example if deserializing JNumber to object field ("10" can be either int, long, float or double).
		/// </summary>
		/// <value>
		/// False by default, set true to allow more loose deserialization.
		/// </value>
		public bool AllowFieldsToBeObjects {
			set {
				allowFieldsToBeObjects = value;
			}
			get {
				return allowFieldsToBeObjects;
			}
		}

		private bool allowNonStringDictionaryKeys = false;

		/// <summary>
		/// By default this is false. Meaning that if any JSON object is deserialized to dictionary, target dictionary must be using string keys, like JSON itself is using.
		/// 
		/// If this is set true, dictionaries key type may also be integer or long. In this case deserialization try to change JSON keys to required dictionary key type.
		/// Note however that this may cause several problems when deserializing. For example, JSON object may contain keys "1" and "01". Deserializing this to Dictionary
		/// with string keys can be done without issues. But deserializing that JSON to Dictionary with integer keys causes error due duplicate key, even original JSON is
		/// completely valid.
		/// </summary>
		/// <value>
		/// False by default, set true to allow more loose and flexible deserialization to dictionaries.
		/// </value>
		public bool AllowNonStringDictionaryKeys {
			set {
				allowNonStringDictionaryKeys = value;
			}
			get {
				return allowNonStringDictionaryKeys;
			}
		}

		private bool allowDeserializeIntsToEnums = false;
		
		/// <summary>
		/// By default this is false. Enum values are expected to have field "value__" in JSON data.
		/// See <see cref="SerializeSettings.SerializeEnumsDirectlyToInts"/> for more info.
		///
		/// If this is set true, deserialization allows integer value from JSON data to be used as enum value.
		/// </summary>
		/// <value>
		/// False by default, set true to allow applying integer values as enum values.
		/// </value>
		public bool AllowDeserializeIntsToEnums {
			set {
				allowDeserializeIntsToEnums = value;
			}
			get {
				return allowDeserializeIntsToEnums;
			}
		}

		private bool ignoreSystemAndUnitySerializeAttributes = false;

		/// <summary>
		/// By default this is false. Meaning that deserialization will check fields for UnityEngine.SerializeField and System.NonSerialized attributes and follow those.
		/// 
		/// In case these attributes are required for other uses but JSON deserialization should not follow these attributes, you can set this setting to true and those
		/// attributes will be ignored during JSON deserialization. You can still include/exclude single fields during deserialization using TotalJSON's own
		/// IncludeToJSONSerialize and ExcludeFromJSONSerialize attributes which are always followed regardless of this setting.
		/// </summary>
		/// <value>
		/// False by default, set true to ignore non-json specific serialization attributes.
		/// </value>
		public bool IgnoreSystemAndUnitySerializeAttributes {
			set {
				ignoreSystemAndUnitySerializeAttributes = value;
			}
			get {
				return ignoreSystemAndUnitySerializeAttributes;
			}
		}

		private bool requireAllFieldsArePopulated = true;

		/// <summary>
		/// Default is true, meaning all the public fields in class/struct where JSON is deserialized must get their value set. So source JSON must contain matching values
		/// for all the fields.
		/// 
		/// If set to false, fields that have no matching data in JSON are just left in their default values.
		/// 
		/// For example, with default setting, deserializing JSON {"a":1,"b":2} to class { public int a; public int b; public int c; } will cause exception since there's
		/// no value for field 'c'.
		/// </summary>
		/// <value>
		/// True by default, set false to allow classes/structs not to get fully populated.
		/// </value>
		public bool RequireAllFieldsArePopulated {
			set {
				requireAllFieldsArePopulated = value;
			}
			get {
				return requireAllFieldsArePopulated;
			}
		}

		private bool requireAllJSONValuesAreUsed = false;

		/// <summary>
		/// Default is false, meaning that any possible extra values in source JSON are ignored. If set to true, it is strictly required that all the values from JSON must
		/// get used to populate some field in target class/struct.
		/// 
		/// For example, with default setting, deserializing JSON {"a":1,"b":2,"c":3} to class { public int a; public int b; } is acceptable and JSON value for 'c' is just
		/// not used.
		/// </summary>
		/// <value>
		/// False by default, set true to require that everything in source JSON is used.
		/// </value>
		public bool RequireAllJSONValuesAreUsed {
			set {
				requireAllJSONValuesAreUsed = value;
			}
			get {
				return requireAllJSONValuesAreUsed;
			}
		}

	}

}