-
Notifications
You must be signed in to change notification settings - Fork 260
/
SchemaValidator.xml
134 lines (134 loc) · 7.97 KB
/
SchemaValidator.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
<Type Name="SchemaValidator" FullName="Azure.Core.SchemaValidator">
<TypeSignature Language="C#" Value="public abstract class SchemaValidator" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit SchemaValidator extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.Core.SchemaValidator" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class SchemaValidator" />
<TypeSignature Language="F#" Value="type SchemaValidator = class" />
<AssemblyInfo>
<AssemblyName>Azure.Core.Experimental</AssemblyName>
<AssemblyVersion>0.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
This abstract class allows any available library to be used to generate schemas from .NET types and validate
objects against schemas.
</summary>
<remarks>
Defining both <see cref="M:Azure.Core.SchemaValidator.GenerateSchema(System.Type)" /> and <see cref="M:Azure.Core.SchemaValidator.TryValidate(System.Object,System.Type,System.String,System.Collections.Generic.IEnumerable{System.Exception}@)" /> is required. If you
do not wish to validate, then evaluate all schemas as valid.
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected SchemaValidator ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Core.SchemaValidator.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core.Experimental</AssemblyName>
<AssemblyVersion>0.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GenerateSchema">
<MemberSignature Language="C#" Value="public abstract string GenerateSchema (Type dataType);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance string GenerateSchema(class System.Type dataType) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Core.SchemaValidator.GenerateSchema(System.Type)" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function GenerateSchema (dataType As Type) As String" />
<MemberSignature Language="F#" Value="abstract member GenerateSchema : Type -> string" Usage="schemaValidator.GenerateSchema dataType" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core.Experimental</AssemblyName>
<AssemblyVersion>0.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="dataType" Type="System.Type" />
</Parameters>
<Docs>
<param name="dataType">The type of the data to use when generating the schema.</param>
<summary>
Generates a schema from <paramref name="dataType" /> and returns it as a string.
</summary>
<returns>The generated schema in string format.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TryValidate">
<MemberSignature Language="C#" Value="public abstract bool TryValidate (object data, Type dataType, string schemaDefinition, out System.Collections.Generic.IEnumerable<Exception> validationErrors);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool TryValidate(object data, class System.Type dataType, string schemaDefinition, [out] class System.Collections.Generic.IEnumerable`1<class System.Exception>& validationErrors) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Core.SchemaValidator.TryValidate(System.Object,System.Type,System.String,System.Collections.Generic.IEnumerable{System.Exception}@)" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function TryValidate (data As Object, dataType As Type, schemaDefinition As String, ByRef validationErrors As IEnumerable(Of Exception)) As Boolean" />
<MemberSignature Language="F#" Value="abstract member TryValidate : obj * Type * string * seq -> bool" Usage="schemaValidator.TryValidate (data, dataType, schemaDefinition, validationErrors)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core.Experimental</AssemblyName>
<AssemblyVersion>0.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="data" Type="System.Object" />
<Parameter Name="dataType" Type="System.Type" />
<Parameter Name="schemaDefinition" Type="System.String" />
<Parameter Name="validationErrors" Type="System.Collections.Generic.IEnumerable<System.Exception>" RefType="out" />
</Parameters>
<Docs>
<param name="data">The data to validate.</param>
<param name="dataType">The type of data to validate.</param>
<param name="schemaDefinition">The schema definition to validate against.</param>
<param name="validationErrors">When this method returns, contains the validation errors if <paramref name="data" /> was invalid according to
the <paramref name="schemaDefinition" />.</param>
<summary>
Validates that <paramref name="data" /> is valid according to <paramref name="schemaDefinition" />.
</summary>
<returns />
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Validate">
<MemberSignature Language="C#" Value="public virtual void Validate (object data, Type dataType, string schemaDefinition);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Validate(object data, class System.Type dataType, string schemaDefinition) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Core.SchemaValidator.Validate(System.Object,System.Type,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Sub Validate (data As Object, dataType As Type, schemaDefinition As String)" />
<MemberSignature Language="F#" Value="abstract member Validate : obj * Type * string -> unit
override this.Validate : obj * Type * string -> unit" Usage="schemaValidator.Validate (data, dataType, schemaDefinition)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Core.Experimental</AssemblyName>
<AssemblyVersion>0.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="data" Type="System.Object" />
<Parameter Name="dataType" Type="System.Type" />
<Parameter Name="schemaDefinition" Type="System.String" />
</Parameters>
<Docs>
<param name="data">The data to validate.</param>
<param name="dataType">The type of data to validate.</param>
<param name="schemaDefinition">The schema definition to validate against.</param>
<summary>
Validates that <paramref name="data" /> is valid according to <paramref name="schemaDefinition" />. If the object is not valid,
this method throws an <see cref="T:System.AggregateException" /> containing all of the validation errors.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.AggregateException">
<paramref name="data" /> is not valid according to the <paramref name="schemaDefinition" />.</exception>
</Docs>
</Member>
</Members>
</Type>