-
Notifications
You must be signed in to change notification settings - Fork 0
/
IDriver.xml
336 lines (336 loc) · 22.1 KB
/
IDriver.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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
<Type Name="IDriver" FullName="Java.Sql.IDriver">
<TypeSignature Language="C#" Value="public interface IDriver : Android.Runtime.IJavaObject, IDisposable, Java.Interop.IJavaPeerable" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit IDriver implements class Android.Runtime.IJavaObject, class Java.Interop.IJavaPeerable, class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:Java.Sql.IDriver" />
<TypeSignature Language="F#" Value="type IDriver = interface
 interface IJavaObject
 interface IDisposable
 interface IJavaPeerable" />
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces>
<Interface>
<InterfaceName>Android.Runtime.IJavaObject</InterfaceName>
</Interface>
<Interface>
<InterfaceName>Java.Interop.IJavaPeerable</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("java/sql/Driver", "", "Java.Sql.IDriverInvoker")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("java/sql/Driver", "", "Java.Sql.IDriverInvoker")>]</AttributeName>
</Attribute>
</Attributes>
<Docs since="1">
<summary>The interface that every driver class must implement.</summary>
<remarks>
<para>The interface that every driver class must implement.</para>
<para>The Java SQL framework allows for multiple database drivers.</para>
<para>Each driver should supply a class that implements
the Driver interface.</para>
<para>The DriverManager will try to load as many drivers as it can
find and then for any given connection request, it will ask each
driver in turn to try to connect to the target URL.</para>
<para>It is strongly recommended that each Driver class should be
small and standalone so that the Driver class can be loaded and
queried without bringing in vast quantities of supporting code.</para>
<para>When a Driver class is loaded, it should create an instance of
itself and register it with the DriverManager. This means that a
user can load and register a driver by calling</para>
<code lang="text/java"><code>Class.forName("foo.bah.Driver")</code>
</code>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/sql/Driver" title="Reference documentation">Java documentation for <code>java.sql.Driver</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
</Docs>
<Members>
<Member MemberName="AcceptsURL">
<MemberSignature Language="C#" Value="public bool AcceptsURL (string? url);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool AcceptsURL(string url) cil managed" />
<MemberSignature Language="DocId" Value="M:Java.Sql.IDriver.AcceptsURL(System.String)" />
<MemberSignature Language="F#" Value="abstract member AcceptsURL : string -> bool" Usage="iDriver.AcceptsURL url" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("acceptsURL", "(Ljava/lang/String;)Z", "GetAcceptsURL_Ljava_lang_String_Handler:Java.Sql.IDriverInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("acceptsURL", "(Ljava/lang/String;)Z", "GetAcceptsURL_Ljava_lang_String_Handler:Java.Sql.IDriverInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="url" Type="System.String" />
</Parameters>
<Docs>
<param name="url">the URL of the database</param>
<summary>Retrieves whether the driver thinks that it can open a connection
to the given URL.</summary>
<returns>
<c>true</c> if this driver understands the given URL;
<c>false</c> otherwise</returns>
<remarks>
<para>Retrieves whether the driver thinks that it can open a connection
to the given URL. Typically drivers will return <c>true</c> if they
understand the subprotocol specified in the URL and <c>false</c> if
they do not.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/sql/Driver#acceptsURL(java.lang.String)" title="Reference documentation">Java documentation for <code>java.sql.Driver.acceptsURL(java.lang.String)</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
<exception cref="T:Java.Sql.SQLException">if a database error occurs.
</exception>
</Docs>
</Member>
<Member MemberName="Connect">
<MemberSignature Language="C#" Value="public Java.Sql.IConnection? Connect (string? url, Java.Util.Properties? info);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Java.Sql.IConnection Connect(string url, class Java.Util.Properties info) cil managed" />
<MemberSignature Language="DocId" Value="M:Java.Sql.IDriver.Connect(System.String,Java.Util.Properties)" />
<MemberSignature Language="F#" Value="abstract member Connect : string * Java.Util.Properties -> Java.Sql.IConnection" Usage="iDriver.Connect (url, info)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("connect", "(Ljava/lang/String;Ljava/util/Properties;)Ljava/sql/Connection;", "GetConnect_Ljava_lang_String_Ljava_util_Properties_Handler:Java.Sql.IDriverInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("connect", "(Ljava/lang/String;Ljava/util/Properties;)Ljava/sql/Connection;", "GetConnect_Ljava_lang_String_Ljava_util_Properties_Handler:Java.Sql.IDriverInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Java.Sql.IConnection</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="url" Type="System.String" />
<Parameter Name="info" Type="Java.Util.Properties" />
</Parameters>
<Docs>
<param name="url">the URL of the database to which to connect</param>
<param name="info">a list of arbitrary string tag/value pairs as
connection arguments. Normally at least a "user" and
"password" property should be included.</param>
<summary>Attempts to make a database connection to the given URL.</summary>
<returns>a <c>Connection</c> object that represents a
connection to the URL</returns>
<remarks>
<para>Attempts to make a database connection to the given URL.
The driver should return "null" if it realizes it is the wrong kind
of driver to connect to the given URL. This will be common, as when
the JDBC driver manager is asked to connect to a given URL it passes
the URL to each loaded driver in turn.</para>
<para>The driver should throw an <c>SQLException</c> if it is the right
driver to connect to the given URL but has trouble connecting to
the database.</para>
<para>The <c>java.util.Properties</c> argument can be used to pass
arbitrary string tag/value pairs as connection arguments.
Normally at least "user" and "password" properties should be
included in the <c>Properties</c> object.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/sql/Driver#connect(java.lang.String,%20java.util.Properties)" title="Reference documentation">Java documentation for <code>java.sql.Driver.connect(java.lang.String, java.util.Properties)</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
<exception cref="T:Java.Sql.SQLException">if a database error occurs.
</exception>
</Docs>
</Member>
<Member MemberName="GetPropertyInfo">
<MemberSignature Language="C#" Value="public Java.Sql.DriverPropertyInfo[]? GetPropertyInfo (string? url, Java.Util.Properties? info);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Java.Sql.DriverPropertyInfo[] GetPropertyInfo(string url, class Java.Util.Properties info) cil managed" />
<MemberSignature Language="DocId" Value="M:Java.Sql.IDriver.GetPropertyInfo(System.String,Java.Util.Properties)" />
<MemberSignature Language="F#" Value="abstract member GetPropertyInfo : string * Java.Util.Properties -> Java.Sql.DriverPropertyInfo[]" Usage="iDriver.GetPropertyInfo (url, info)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("getPropertyInfo", "(Ljava/lang/String;Ljava/util/Properties;)[Ljava/sql/DriverPropertyInfo;", "GetGetPropertyInfo_Ljava_lang_String_Ljava_util_Properties_Handler:Java.Sql.IDriverInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("getPropertyInfo", "(Ljava/lang/String;Ljava/util/Properties;)[Ljava/sql/DriverPropertyInfo;", "GetGetPropertyInfo_Ljava_lang_String_Ljava_util_Properties_Handler:Java.Sql.IDriverInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Java.Sql.DriverPropertyInfo[]</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="url" Type="System.String" />
<Parameter Name="info" Type="Java.Util.Properties" />
</Parameters>
<Docs>
<param name="url">the URL of the database to which to connect</param>
<param name="info">a proposed list of tag/value pairs that will be sent on
connect open</param>
<summary>Gets information about the possible properties for this driver.</summary>
<returns>an array of <c>DriverPropertyInfo</c> objects describing
possible properties. This array may be an empty array if
no properties are required.</returns>
<remarks>
<para>Gets information about the possible properties for this driver.</para>
<para>The <c>getPropertyInfo</c> method is intended to allow a generic
GUI tool to discover what properties it should prompt
a human for in order to get
enough information to connect to a database. Note that depending on
the values the human has supplied so far, additional values may become
necessary, so it may be necessary to iterate though several calls
to the <c>getPropertyInfo</c> method.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/sql/Driver#getPropertyInfo(java.lang.String,%20java.util.Properties)" title="Reference documentation">Java documentation for <code>java.sql.Driver.getPropertyInfo(java.lang.String, java.util.Properties)</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
<exception cref="T:Java.Sql.SQLException">if a database error occurs.
</exception>
</Docs>
</Member>
<Member MemberName="JdbcCompliant">
<MemberSignature Language="C#" Value="public bool JdbcCompliant ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool JdbcCompliant() cil managed" />
<MemberSignature Language="DocId" Value="M:Java.Sql.IDriver.JdbcCompliant" />
<MemberSignature Language="F#" Value="abstract member JdbcCompliant : unit -> bool" Usage="iDriver.JdbcCompliant " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Android.Runtime.Register("jdbcCompliant", "()Z", "GetJdbcCompliantHandler:Java.Sql.IDriverInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]</AttributeName>
<AttributeName Language="F#">[<Android.Runtime.Register("jdbcCompliant", "()Z", "GetJdbcCompliantHandler:Java.Sql.IDriverInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Reports whether this driver is a genuine JDBC
Compliant<sup><font size=-2>TM</font></sup> driver.</summary>
<returns>
<c>true</c> if this driver is JDBC Compliant; <c>false</c>
otherwise</returns>
<remarks>
<para>Reports whether this driver is a genuine JDBC
Compliant<sup><font size=-2>TM</font></sup> driver.
A driver may only report <c>true</c> here if it passes the JDBC
compliance tests; otherwise it is required to return <c>false</c>.</para>
<para>JDBC compliance requires full support for the JDBC API and full support
for SQL 92 Entry Level. It is expected that JDBC compliant drivers will
be available for all the major commercial databases.</para>
<para>This method is not intended to encourage the development of non-JDBC
compliant drivers, but is a recognition of the fact that some vendors
are interested in using the JDBC API and framework for lightweight
databases that do not support full database functionality, or for
special databases such as document information retrieval where a SQL
implementation may not be feasible.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/java/sql/Driver#jdbcCompliant()" title="Reference documentation">Java documentation for <code>java.sql.Driver.jdbcCompliant()</code>.</a>
</format>
</para>
<para>
Portions of this page are modifications based on work created and shared by the
<format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format>
and used according to terms described in the
<format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
</Docs>
</Member>
<Member MemberName="MajorVersion">
<MemberSignature Language="C#" Value="public int MajorVersion { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 MajorVersion" />
<MemberSignature Language="DocId" Value="P:Java.Sql.IDriver.MajorVersion" />
<MemberSignature Language="F#" Value="member this.MajorVersion : int" Usage="Java.Sql.IDriver.MajorVersion" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[get: Android.Runtime.Register("getMajorVersion", "()I", "GetGetMajorVersionHandler:Java.Sql.IDriverInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]</AttributeName>
<AttributeName Language="F#">[<get: Android.Runtime.Register("getMajorVersion", "()I", "GetGetMajorVersionHandler:Java.Sql.IDriverInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the driver's major version number.</summary>
<value>To be added.</value>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
</Docs>
</Member>
<Member MemberName="MinorVersion">
<MemberSignature Language="C#" Value="public int MinorVersion { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 MinorVersion" />
<MemberSignature Language="DocId" Value="P:Java.Sql.IDriver.MinorVersion" />
<MemberSignature Language="F#" Value="member this.MinorVersion : int" Usage="Java.Sql.IDriver.MinorVersion" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[get: Android.Runtime.Register("getMinorVersion", "()I", "GetGetMinorVersionHandler:Java.Sql.IDriverInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]</AttributeName>
<AttributeName Language="F#">[<get: Android.Runtime.Register("getMinorVersion", "()I", "GetGetMinorVersionHandler:Java.Sql.IDriverInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the driver's minor version number.</summary>
<value>To be added.</value>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
</Docs>
</Member>
</Members>
</Type>