- All Superinterfaces:
AutoCloseable
- All Known Implementing Classes:
SerialArray
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:
- create a class that implements the
SQLDatainterface for the UDT to be custom mapped. - make an entry in a type map that contains
- the fully-qualified SQL type name of the UDT
- the
Classobject for the class implementingSQLData
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.
To release resources used by the Array
object, applications must call either the free()
or the close()
method. Any attempt to invoke a method other than free()
or close()
after the Array
object has been closed, will result in a SQLException
being thrown.
All methods on the Array
interface must be fully implemented if the JDBC driver supports the data type.
- Since:
- 1.2
Methods
- +Only in: JDBC 4.5; not in: JDBC 4.4.public default void close() throws java.sql.SQLExceptionNot in JDBC 4.4; only in JDBC 4.5
close
Closes and releases the resources held by thisArrayobject.If the
Arrayobject is already closed, then invoking this method has no effect.- Specified by:
closein interfaceAutoCloseable- Implementation Requirements:
- The default implementation calls the
free()method. - Throws:
SQLException- if an error occurs releasing the Array's resourcesSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 26
- See Also:
- ≠public abstract void free() throws java.sql.SQLExceptionComparing JDBC 4.4 and JDBC 4.5
free
This method frees theArrayobject Closes and releases the resources that it holds. The object is invalid once thefreemethod is called. held by thisArrayobject.If the
Arrayobject is already closed, then invoking this method has no effect Afterfreehas been called, any attempt to invoke a method other thanfreewill result in aSQLExceptionbeing thrown. Iffreeis called multiple times, the subsequent calls tofreeare treated as a no-op.- Throws:
SQLException- if an error occurs releasing the Array's resourcesSQLFeatureNotSupportedException- if the JDBC driver does not support this method- Since:
- 1.6
- See Also:
- =public abstract java.lang.Object getArray() throws java.sql.SQLException
- =public abstract java.lang.Object getArray(long arg0, int arg1) throws java.sql.SQLException
- =public abstract java.lang.Object getArray(long arg0, int arg1, java.util.Map<java.lang.String, java.lang.Class<?>> arg2) throws java.sql.SQLException
- =public abstract java.lang.Object getArray(java.util.Map<java.lang.String, java.lang.Class<?>> arg0) throws java.sql.SQLException
- =public abstract int getBaseType() throws java.sql.SQLException
- =public abstract java.lang.String getBaseTypeName() throws java.sql.SQLException
- =public abstract java.sql.ResultSet getResultSet() throws java.sql.SQLException
- =public abstract java.sql.ResultSet getResultSet(long arg0, int arg1) throws java.sql.SQLException
- =public abstract java.sql.ResultSet getResultSet(long arg0, int arg1, java.util.Map<java.lang.String, java.lang.Class<?>> arg2) throws java.sql.SQLException
- =public abstract java.sql.ResultSet getResultSet(java.util.Map<java.lang.String, java.lang.Class<?>> arg0) throws java.sql.SQLException
Summary
| Elements | Comments | Descriptions | Total | |||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Added | Changed | Removed | Added | Changed | Removed | Added | Changed | Removed | ||
| Array | 2 | 13 | 15 | |||||||
| close() | 1 | 1 | 2 | |||||||
| free() | 6 | 2 | 2 | 10 | ||||||
| Total | 1 | 2 | 20 | 2 | 2 | 27 | ||||