2 // Copyright (c) 2007 James Newton-King
4 // Permission is hereby granted, free of charge, to any person
5 // obtaining a copy of this software and associated documentation
6 // files (the "Software"), to deal in the Software without
7 // restriction, including without limitation the rights to use,
8 // copy, modify, merge, publish, distribute, sublicense, and/or sell
9 // copies of the Software, and to permit persons to whom the
10 // Software is furnished to do so, subject to the following
13 // The above copyright notice and this permission notice shall be
14 // included in all copies or substantial portions of the Software.
16 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
18 // OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
20 // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
21 // WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
22 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
23 // OTHER DEALINGS IN THE SOFTWARE.
28 namespace Newtonsoft.Json.Converters
31 /// Create a custom object
33 /// <typeparam name="T"></typeparam>
34 public abstract class CustomCreationConverter<T> : JsonConverter
37 /// Writes the JSON representation of the object.
39 /// <param name="writer">The <see cref="JsonWriter"/> to write to.</param>
40 /// <param name="value">The value.</param>
41 /// <param name="serializer">The calling serializer.</param>
42 public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
44 throw new NotSupportedException("CustomCreationConverter should only be used while deserializing.");
48 /// Reads the JSON representation of the object.
50 /// <param name="reader">The <see cref="JsonReader"/> to read from.</param>
51 /// <param name="objectType">Type of the object.</param>
52 /// <param name="existingValue">The existing value of object being read.</param>
53 /// <param name="serializer">The calling serializer.</param>
54 /// <returns>The object value.</returns>
55 public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
57 if (reader.TokenType == JsonToken.Null)
60 T value = Create(objectType);
62 throw new JsonSerializationException("No object created.");
64 serializer.Populate(reader, value);
69 /// Creates an object which will then be populated by the serializer.
71 /// <param name="objectType">Type of the object.</param>
72 /// <returns></returns>
73 public abstract T Create(Type objectType);
76 /// Determines whether this instance can convert the specified object type.
78 /// <param name="objectType">Type of the object.</param>
80 /// <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.
82 public override bool CanConvert(Type objectType)
84 return typeof (T).IsAssignableFrom(objectType);
88 /// Gets a value indicating whether this <see cref="JsonConverter"/> can write JSON.
91 /// <c>true</c> if this <see cref="JsonConverter"/> can write JSON; otherwise, <c>false</c>.
93 public override bool CanWrite