Summary: Methods
Since: API Level 1
public interface

Array

java.sql.Array

Class Overview

A Java representation of the SQL ARRAY type.

Summary

Public Methods
abstract void free()
Frees any resources held by this array.
abstract Object getArray(long index, int count, Map<String, Class<?>> map)
Returns part of the SQL ARRAY associated with this array, starting at a particular index and comprising up to count successive elements of the SQL array.
abstract Object getArray()
Retrieves the contents of the SQL ARRAY value as a Java array object.
abstract Object getArray(Map<String, Class<?>> map)
Returns the data from the underlying SQL ARRAY as a Java array.
abstract Object getArray(long index, int count)
Returns part of the SQL ARRAY associated with this array, starting at a particular index and comprising up to count successive elements of the SQL array.
abstract int getBaseType()
Returns the JDBC type of the entries in this array's underlying SQL array.
abstract String getBaseTypeName()
Returns the SQL type name of the entries in this array's underlying SQL array.
abstract ResultSet getResultSet()
Returns a ResultSet object which holds the entries of the SQL ARRAY associated with this array.
abstract ResultSet getResultSet(long index, int count, Map<String, Class<?>> map)
Returns a ResultSet object that holds the entries of a subarray, beginning at a particular index and comprising up to count successive entries.
abstract ResultSet getResultSet(Map<String, Class<?>> map)
Returns a ResultSet object which holds the entries of the SQL ARRAY associated with this array.
abstract ResultSet getResultSet(long index, int count)
Returns a ResultSet object that holds the entries of a subarray, beginning at a particular index and comprising up to count successive entries.

Public Methods

public abstract void free ()

Since: API Level 9

Frees any resources held by this array. After free is called, calling method other than free will throw SQLException (calling free repeatedly will do nothing).

Throws
SQLException

public abstract Object getArray (long index, int count, Map<String, Class<?>> map)

Since: API Level 1

Returns part of the SQL ARRAY associated with this array, starting at a particular index and comprising up to count successive elements of the SQL array.

Parameters
index the start position in the array where the values are retrieved.
count the number of elements to retrieve.
map the map defining the correspondence between SQL type names and Java types.
Returns
  • A Java array containing the desired set of elements from this Array
Throws
SQLException if there is a database error.

public abstract Object getArray ()

Since: API Level 1

Retrieves the contents of the SQL ARRAY value as a Java array object.

Returns
  • A Java array containing the elements of this Array
Throws
SQLException if there is a database error.

public abstract Object getArray (Map<String, Class<?>> map)

Since: API Level 1

Returns the data from the underlying SQL ARRAY as a Java array.

Parameters
map the map defining the correspondence between SQL type names and Java types.
Returns
  • A Java array containing the elements of this array
Throws
SQLException if there is a database error.

public abstract Object getArray (long index, int count)

Since: API Level 1

Returns part of the SQL ARRAY associated with this array, starting at a particular index and comprising up to count successive elements of the SQL array.

Parameters
index the start position in the array where the values are retrieved.
count the number of elements to retrieve.
Returns
  • A Java array containing the desired set of elements from this Array
Throws
SQLException if there is a database error.

public abstract int getBaseType ()

Since: API Level 1

Returns the JDBC type of the entries in this array's underlying SQL array.

Returns
  • An integer constant from the java.sql.Types class
Throws
SQLException if there is a database error.

public abstract String getBaseTypeName ()

Since: API Level 1

Returns the SQL type name of the entries in this array's underlying SQL array.

Returns
  • The database specific name or a fully-qualified SQL type name.
Throws
SQLException if there is a database error.

public abstract ResultSet getResultSet ()

Since: API Level 1

Returns a ResultSet object which holds the entries of the SQL ARRAY associated with this array.

Returns
  • the elements of the array as a ResultSet.
Throws
SQLException if there is a database error.

public abstract ResultSet getResultSet (long index, int count, Map<String, Class<?>> map)

Since: API Level 1

Returns a ResultSet object that holds the entries of a subarray, beginning at a particular index and comprising up to count successive entries.

Parameters
index the start position in the array where the values are retrieved.
count the number of elements to retrieve.
map the map defining the correspondence between SQL type names and Java types.
Returns
  • the ResultSet the array's custom type values. if a database error has occurred.
Throws
SQLException if there is a database error.

public abstract ResultSet getResultSet (Map<String, Class<?>> map)

Since: API Level 1

Returns a ResultSet object which holds the entries of the SQL ARRAY associated with this array.

Parameters
map the map defining the correspondence between SQL type names and Java types.
Returns
  • the array as a ResultSet.
Throws
SQLException if there is a database error.

public abstract ResultSet getResultSet (long index, int count)

Since: API Level 1

Returns a ResultSet object that holds the entries of a subarray, beginning at a particular index and comprising up to count successive entries.

Parameters
index the start position in the array where the values are retrieved.
count the number of elements to retrieve.
Returns
  • the elements of the array as a ResultSet.
Throws
SQLException if there is a database error.