1 #region License 2 // Copyright (c) 2007 James Newton-King 3 // 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 11 // conditions: 12 // 13 // The above copyright notice and this permission notice shall be 14 // included in all copies or substantial portions of the Software. 15 // 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. 24 #endregion 25 26 using System.Collections.Generic; 27 using Newtonsoft.Json.Linq; 28 using Newtonsoft.Json.Utilities; 29 30 namespace Newtonsoft.Json.Schema 31 { 32 /// <summary> 33 /// Contains the JSON schema extension methods. 34 /// </summary> 35 public static class Extensions 36 { 37 /// <summary> 38 /// Determines whether the <see cref="JToken"/> is valid. 39 /// </summary> 40 /// <param name="source">The source <see cref="JToken"/> to test.</param> 41 /// <param name="schema">The schema to test with.</param> 42 /// <returns> 43 /// <c>true</c> if the specified <see cref="JToken"/> is valid; otherwise, <c>false</c>. 44 /// </returns> IsValid(this JToken source, JsonSchema schema)45 public static bool IsValid(this JToken source, JsonSchema schema) 46 { 47 bool valid = true; 48 source.Validate(schema, (sender, args) => { valid = false; }); 49 return valid; 50 } 51 52 /// <summary> 53 /// Determines whether the <see cref="JToken"/> is valid. 54 /// </summary> 55 /// <param name="source">The source <see cref="JToken"/> to test.</param> 56 /// <param name="schema">The schema to test with.</param> 57 /// <param name="errorMessages">When this method returns, contains any error messages generated while validating. </param> 58 /// <returns> 59 /// <c>true</c> if the specified <see cref="JToken"/> is valid; otherwise, <c>false</c>. 60 /// </returns> IsValid(this JToken source, JsonSchema schema, out IList<string> errorMessages)61 public static bool IsValid(this JToken source, JsonSchema schema, out IList<string> errorMessages) 62 { 63 IList<string> errors = new List<string>(); 64 65 source.Validate(schema, (sender, args) => errors.Add(args.Message)); 66 67 errorMessages = errors; 68 return (errorMessages.Count == 0); 69 } 70 71 /// <summary> 72 /// Validates the specified <see cref="JToken"/>. 73 /// </summary> 74 /// <param name="source">The source <see cref="JToken"/> to test.</param> 75 /// <param name="schema">The schema to test with.</param> Validate(this JToken source, JsonSchema schema)76 public static void Validate(this JToken source, JsonSchema schema) 77 { 78 source.Validate(schema, null); 79 } 80 81 /// <summary> 82 /// Validates the specified <see cref="JToken"/>. 83 /// </summary> 84 /// <param name="source">The source <see cref="JToken"/> to test.</param> 85 /// <param name="schema">The schema to test with.</param> 86 /// <param name="validationEventHandler">The validation event handler.</param> Validate(this JToken source, JsonSchema schema, ValidationEventHandler validationEventHandler)87 public static void Validate(this JToken source, JsonSchema schema, ValidationEventHandler validationEventHandler) 88 { 89 ValidationUtils.ArgumentNotNull(source, "source"); 90 ValidationUtils.ArgumentNotNull(schema, "schema"); 91 92 using (JsonValidatingReader reader = new JsonValidatingReader(source.CreateReader())) 93 { 94 reader.Schema = schema; 95 if (validationEventHandler != null) 96 reader.ValidationEventHandler += validationEventHandler; 97 98 while (reader.Read()) 99 { 100 } 101 } 102 } 103 } 104 } 105