IArray Interface

Reference

Definition

Namespace:: Java.Sql

Assembly:: Mono.Android.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The mapping in the Java programming language for the SQL type ARRAY.

[Android.Runtime.Register("java/sql/Array", "", "Java.Sql.IArrayInvoker")]
public interface IArray : Android.Runtime.IJavaObject, IDisposable, Java.Interop.IJavaPeerable

[<Android.Runtime.Register("java/sql/Array", "", "Java.Sql.IArrayInvoker")>]
type IArray = interface
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable

Attributes: RegisterAttribute

Implements: IJavaObject IJavaPeerable IDisposable

Remarks

The mapping in the Java programming language for the SQL type ARRAY. By default, an Array value is a transaction-duration reference to an SQL ARRAY value. By default, an Array object is implemented using an SQL LOCATOR(array) internally, which means that an Array object contains a logical pointer to the data in the SQL ARRAY value rather than containing the ARRAY value's data.

The Array interface provides methods for bringing an SQL ARRAY value's data to the client as either an array or a ResultSet object. If the elements of the SQL ARRAY are a UDT, they may be custom mapped. To create a custom mapping, a programmer must do two things: <ul> <li>create a class that implements the SQLData interface for the UDT to be custom mapped. <li>make an entry in a type map that contains <ul> <li>the fully-qualified SQL type name of the UDT <li>the Class object for the class implementing SQLData</ul> </ul>

When a type map with an entry for the base type is supplied to the methods getArray and getResultSet, the mapping it contains will be used to map the elements of the ARRAY value. If no type map is supplied, which would typically be the case, the connection's type map is used by default. If the connection's type map or a type map supplied to a method has no entry for the base type, the elements are mapped according to the standard mapping.

All methods on the Array interface must be fully implemented if the JDBC driver supports the data type.

Added in 1.2.

Java documentation for java.sql.Array.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Properties

Array	Retrieves the contents of the SQL `ARRAY` value as a Java array object.
BaseType	Returns the JDBC type of the entries in this array's underlying SQL array.
BaseTypeName	Returns the SQL type name of the entries in this array's underlying SQL array.
Handle	Gets the JNI value of the underlying Android object. (Inherited from IJavaObject)
JniIdentityHashCode	Returns the value of `java.lang.System.identityHashCode()` for the wrapped instance. (Inherited from IJavaPeerable)
JniManagedPeerState	State of the managed peer. (Inherited from IJavaPeerable)
JniPeerMembers	Member access and invocation support. (Inherited from IJavaPeerable)
PeerReference	Returns a JniObjectReference of the wrapped Java object instance. (Inherited from IJavaPeerable)
ResultSet	Returns a ResultSet object which holds the entries of the SQL `ARRAY` associated with this array.

Methods

Disposed()	Called when the instance has been disposed. (Inherited from IJavaPeerable)
DisposeUnlessReferenced()	If there are no outstanding references to this instance, then calls `Dispose()`; otherwise, does nothing. (Inherited from IJavaPeerable)
Finalized()	Called when the instance has been finalized. (Inherited from IJavaPeerable)
Free()	This method frees the `Array` object and releases the resources that it holds.
GetArray(IDictionary<String,Class>)	Retrieves the contents of the SQL `ARRAY` value designated by this `Array` object.
GetArray(Int64, Int32)	Retrieves a slice of the SQL `ARRAY` value designated by this `Array` object, beginning with the specified `index` and containing up to `count` successive elements of the SQL array.
GetArray(Int64, Int32, IDictionary<String,Class>)	Retreives a slice of the SQL `ARRAY` value designated by this `Array` object, beginning with the specified `index` and containing up to `count` successive elements of the SQL array.
GetResultSet(IDictionary<String,Class>)	Retrieves a result set that contains the elements of the SQL `ARRAY` value designated by this `Array` object.
GetResultSet(Int64, Int32)	Retrieves a result set holding the elements of the subarray that starts at index `index` and contains up to `count` successive elements.
GetResultSet(Int64, Int32, IDictionary<String,Class>)	Retrieves a result set holding the elements of the subarray that starts at index `index` and contains up to `count` successive elements.
SetJniIdentityHashCode(Int32)	Set the value returned by `JniIdentityHashCode`. (Inherited from IJavaPeerable)
SetJniManagedPeerState(JniManagedPeerStates)	(Inherited from IJavaPeerable)
SetPeerReference(JniObjectReference)	Set the value returned by `PeerReference`. (Inherited from IJavaPeerable)
UnregisterFromRuntime()	Unregister this instance so that the runtime will not return it from future Java.Interop.JniRuntime+JniValueManager.PeekValue invocations. (Inherited from IJavaPeerable)

Extension Methods

JavaCast<TResult>(IJavaObject)	Performs an Android runtime-checked type conversion.
JavaCast<TResult>(IJavaObject)
GetJniTypeName(IJavaPeerable)

Applies to