jOOQ 3.18.7 · org.jooq.tools.jdbc.MockArray

Modifier and Type	Field and Description
private final T[]	array
private final SQLDialect	dialect
private final Class<? extends T[]>	type

Access	Constructor and Description
public	MockArray(SQLDialect dialect, T[] array, Class<? extends T[]> type)

Method Summary

Modifier and Type	Method and Description
public void	free() Implements java.sql.Array.free. This method frees the `Array` object and releases the resources that it holds.
public T[]	getArray() Implements java.sql.Array.getArray. Retrieves the contents of the SQL `ARRAY` value designated by this `Array` object in the form of an array in the Java programming language.
public T[]	getArray(Map<String, Class<?>> a `java.util.Map` object that contains mappings of SQL type names to classes in the Java programming language map) Implements java.sql.Array.getArray. Retrieves the contents of the SQL `ARRAY` value designated by this `Array` object.
public T[]	getArray(long the array index of the first element to retrieve; the first element is at index 1 index, int the number of successive SQL array elements to retrieve count) Implements java.sql.Array.getArray. 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.
public T[]	getArray(long the array index of the first element to retrieve; the first element is at index 1 index, int the number of successive SQL array elements to retrieve count, Map<String, Class<?>> a `java.util.Map` object that contains SQL type names and the classes in the Java programming language to which they are mapped map) Implements java.sql.Array.getArray. 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.
public int	getBaseType() Implements java.sql.Array.getBaseType. Retrieves the JDBC type of the elements in the array designated by this `Array` object.
public String	getBaseTypeName() Implements java.sql.Array.getBaseTypeName. Retrieves the SQL type name of the elements in the array designated by this `Array` object.
public ResultSet	getResultSet() Implements java.sql.Array.getResultSet. Retrieves a result set that contains the elements of the SQL `ARRAY` value designated by this `Array` object.
public ResultSet	getResultSet(Map<String, Class<?>> contains the mapping of SQL user-defined types to classes in the Java programming language map) Implements java.sql.Array.getResultSet. Retrieves a result set that contains the elements of the SQL `ARRAY` value designated by this `Array` object.
public ResultSet	getResultSet(long the array index of the first element to retrieve; the first element is at index 1 index, int the number of successive SQL array elements to retrieve count) Implements java.sql.Array.getResultSet. Retrieves a result set holding the elements of the subarray that starts at index `index` and contains up to `count` successive elements.
public ResultSet	getResultSet(long the array index of the first element to retrieve; the first element is at index 1 index, int the number of successive SQL array elements to retrieve count, Map<String, Class<?>> the `Map` object that contains the mapping of SQL type names to classes in the Java(tm) programming language map) Implements java.sql.Array.getResultSet. Retrieves a result set holding the elements of the subarray that starts at index `index` and contains up to `count` successive elements.
private ResultSet	getResultSet0(T[] a)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

array	back to summary
private final T[] array

dialect	back to summary
private final SQLDialect dialect

type	back to summary
private final Class<? extends T[]> type

MockArray	back to summary
public MockArray(SQLDialect dialect, T[] array, Class<? extends T[]> type)

Method Detail

free back to summary

free	back to summary
public void free() Implements java.sql.Array.free. Doc from java.sql.Array.free. This method frees the `Array` object and releases the resources that it holds. The object is invalid once the `free` method is called. After `free` has been called, any attempt to invoke a method other than `free` will result in a `SQLException` being thrown. If `free` is called multiple times, the subsequent calls to `free` are treated as a no-op. Annotations @Override

public void free()

Implements java.sql.Array.free.

Doc from java.sql.Array.free.

This method frees the Array object and releases the resources that it holds. The object is invalid once the free method is called.

After free has been called, any attempt to invoke a method other than free will result in a SQLException being thrown. If free is called multiple times, the subsequent calls to free are treated as a no-op.

Annotations

@Override

getArray back to summary

getArray	back to summary
public T[] getArray() Implements java.sql.Array.getArray. Doc from java.sql.Array.getArray. Retrieves the contents of the SQL `ARRAY` value designated by this `Array` object in the form of an array in the Java programming language. This version of the method `getArray` uses the type map associated with the connection for customizations of the type mappings. Note When `getArray` is used to materialize a base type that maps to a primitive data type, then it is implementation-defined whether the array returned is an array of that primitive data type or an array of `Object`. Returns:T[] an array in the Java programming language that contains the ordered elements of the SQL `ARRAY` value designated by this `Array` object Annotations @Override

public T[] getArray()

Implements java.sql.Array.getArray.

Doc from java.sql.Array.getArray.

Retrieves the contents of the SQL ARRAY value designated by this Array object in the form of an array in the Java programming language. This version of the method getArray uses the type map associated with the connection for customizations of the type mappings.

Note

When getArray is used to materialize a base type that maps to a primitive data type, then it is implementation-defined whether the array returned is an array of that primitive data type or an array of Object.

Returns:T[]

an array in the Java programming language that contains the ordered elements of the SQL ARRAY value designated by this Array object

Annotations

@Override

getArray back to summary

getArray	back to summary
public T[] getArray(Map<String, Class<?>> map) Implements java.sql.Array.getArray. Doc from java.sql.Array.getArray. Retrieves the contents of the SQL `ARRAY` value designated by this `Array` object. This method uses the specified `map` for type map customizations unless the base type of the array does not match a user-defined type in `map`, in which case it uses the standard mapping. This version of the method `getArray` uses either the given type map or the standard mapping; it never uses the type map associated with the connection. Note When `getArray` is used to materialize a base type that maps to a primitive data type, then it is implementation-defined whether the array returned is an array of that primitive data type or an array of `Object`. Parameters map:Map<String, Class<?>> a `java.util.Map` object that contains mappings of SQL type names to classes in the Java programming language Returns:T[] an array in the Java programming language that contains the ordered elements of the SQL array designated by this object Annotations @Override

public T[] getArray(Map<String, Class<?>> map)

Implements java.sql.Array.getArray.

Doc from java.sql.Array.getArray.

Retrieves the contents of the SQL ARRAY value designated by this Array object. This method uses the specified map for type map customizations unless the base type of the array does not match a user-defined type in map, in which case it uses the standard mapping. This version of the method getArray uses either the given type map or the standard mapping; it never uses the type map associated with the connection.

Note

Parameters

map:Map<String, Class<?>>: a java.util.Map object that contains mappings of SQL type names to classes in the Java programming language

Returns:T[]

an array in the Java programming language that contains the ordered elements of the SQL array designated by this object

Annotations

@Override

getArray back to summary

getArray	back to summary
public T[] getArray(long index, int count) throws SQLException Implements java.sql.Array.getArray. Doc from java.sql.Array.getArray. 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. This method uses the type map associated with the connection for customizations of the type mappings. Note When `getArray` is used to materialize a base type that maps to a primitive data type, then it is implementation-defined whether the array returned is an array of that primitive data type or an array of `Object`. Parameters index:long the array index of the first element to retrieve; the first element is at index 1 count:int the number of successive SQL array elements to retrieve Returns:T[] an array containing up to `count` consecutive elements of the SQL array, beginning with element `index` Annotations @SuppressWarnings:unchecked @Override Exceptions SQLException: if an error occurs while attempting to access the array

public T[] getArray(long index, int count) throws SQLException

Implements java.sql.Array.getArray.

Doc from java.sql.Array.getArray.

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. This method uses the type map associated with the connection for customizations of the type mappings.

Note

Parameters

index:long: the array index of the first element to retrieve; the first element is at index 1
count:int: the number of successive SQL array elements to retrieve

Returns:T[]

an array containing up to count consecutive elements of the SQL array, beginning with element index

Annotations

@SuppressWarnings:unchecked
@Override

Exceptions

SQLException:: if an error occurs while attempting to access the array

getArray back to summary

getArray	back to summary
public T[] getArray(long index, int count, Map<String, Class<?>> map) throws SQLException Implements java.sql.Array.getArray. Doc from java.sql.Array.getArray. 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. This method uses the specified `map` for type map customizations unless the base type of the array does not match a user-defined type in `map`, in which case it uses the standard mapping. This version of the method `getArray` uses either the given type map or the standard mapping; it never uses the type map associated with the connection. Note When `getArray` is used to materialize a base type that maps to a primitive data type, then it is implementation-defined whether the array returned is an array of that primitive data type or an array of `Object`. Parameters index:long the array index of the first element to retrieve; the first element is at index 1 count:int the number of successive SQL array elements to retrieve map:Map<String, Class<?>> a `java.util.Map` object that contains SQL type names and the classes in the Java programming language to which they are mapped Returns:T[] an array containing up to `count` consecutive elements of the SQL `ARRAY` value designated by this `Array` object, beginning with element `index` Annotations @Override Exceptions SQLException: if an error occurs while attempting to access the array

public T[] getArray(long index, int count, Map<String, Class<?>> map) throws SQLException

Implements java.sql.Array.getArray.

Doc from java.sql.Array.getArray.

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.

This method uses the specified map for type map customizations unless the base type of the array does not match a user-defined type in map, in which case it uses the standard mapping. This version of the method getArray uses either the given type map or the standard mapping; it never uses the type map associated with the connection.

Note

Parameters

index:long: the array index of the first element to retrieve; the first element is at index 1
count:int: the number of successive SQL array elements to retrieve
map:Map<String, Class<?>>: a java.util.Map object that contains SQL type names and the classes in the Java programming language to which they are mapped

Returns:T[]

an array containing up to count consecutive elements of the SQL ARRAY value designated by this Array object, beginning with element index

Annotations

@Override

Exceptions

SQLException:: if an error occurs while attempting to access the array

getBaseType back to summary

getBaseType	back to summary
public int getBaseType() Implements java.sql.Array.getBaseType. Doc from java.sql.Array.getBaseType. Retrieves the JDBC type of the elements in the array designated by this `Array` object. Returns:int a constant from the class `java.sql.Types` that is the type code for the elements in the array designated by this `Array` object Annotations @Override

public int getBaseType()

Implements java.sql.Array.getBaseType.

Doc from java.sql.Array.getBaseType.

Retrieves the JDBC type of the elements in the array designated by this Array object.

Returns:int

a constant from the class java.sql.Types that is the type code for the elements in the array designated by this Array object

Annotations

@Override

getBaseTypeName back to summary

getBaseTypeName	back to summary
public String getBaseTypeName() Implements java.sql.Array.getBaseTypeName. Doc from java.sql.Array.getBaseTypeName. Retrieves the SQL type name of the elements in the array designated by this `Array` object. If the elements are a built-in type, it returns the database-specific type name of the elements. If the elements are a user-defined type (UDT), this method returns the fully-qualified SQL type name. Returns:String a `String` that is the database-specific name for a built-in base type; or the fully-qualified SQL type name for a base type that is a UDT Annotations @Override

public String getBaseTypeName()

Implements java.sql.Array.getBaseTypeName.

Doc from java.sql.Array.getBaseTypeName.

Retrieves the SQL type name of the elements in the array designated by this Array object. If the elements are a built-in type, it returns the database-specific type name of the elements. If the elements are a user-defined type (UDT), this method returns the fully-qualified SQL type name.

Returns:String

a String that is the database-specific name for a built-in base type; or the fully-qualified SQL type name for a base type that is a UDT

Annotations

@Override

getResultSet back to summary

getResultSet	back to summary
public ResultSet getResultSet() Implements java.sql.Array.getResultSet. Doc from java.sql.Array.getResultSet. Retrieves a result set that contains the elements of the SQL `ARRAY` value designated by this `Array` object. If appropriate, the elements of the array are mapped using the connection's type map; otherwise, the standard mapping is used. The result set contains one row for each array element, with two columns in each row. The second column stores the element value; the first column stores the index into the array for that element (with the first array element being at index 1). The rows are in ascending order corresponding to the order of the indices. Returns:ResultSet a `ResultSet` object containing one row for each of the elements in the array designated by this `Array` object, with the rows in ascending order based on the indices. Annotations @Override

public ResultSet getResultSet()

Implements java.sql.Array.getResultSet.

Doc from java.sql.Array.getResultSet.

Retrieves a result set that contains the elements of the SQL ARRAY value designated by this Array object. If appropriate, the elements of the array are mapped using the connection's type map; otherwise, the standard mapping is used.

The result set contains one row for each array element, with two columns in each row. The second column stores the element value; the first column stores the index into the array for that element (with the first array element being at index 1). The rows are in ascending order corresponding to the order of the indices.

Returns:ResultSet

a ResultSet object containing one row for each of the elements in the array designated by this Array object, with the rows in ascending order based on the indices.

Annotations

@Override

getResultSet back to summary

getResultSet	back to summary
public ResultSet getResultSet(Map<String, Class<?>> map) Implements java.sql.Array.getResultSet. Doc from java.sql.Array.getResultSet. Retrieves a result set that contains the elements of the SQL `ARRAY` value designated by this `Array` object. This method uses the specified `map` for type map customizations unless the base type of the array does not match a user-defined type in `map`, in which case it uses the standard mapping. This version of the method `getResultSet` uses either the given type map or the standard mapping; it never uses the type map associated with the connection. The result set contains one row for each array element, with two columns in each row. The second column stores the element value; the first column stores the index into the array for that element (with the first array element being at index 1). The rows are in ascending order corresponding to the order of the indices. Parameters map:Map<String, Class<?>> contains the mapping of SQL user-defined types to classes in the Java programming language Returns:ResultSet a `ResultSet` object containing one row for each of the elements in the array designated by this `Array` object, with the rows in ascending order based on the indices. Annotations @Override

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

Implements java.sql.Array.getResultSet.

Doc from java.sql.Array.getResultSet.

Retrieves a result set that contains the elements of the SQL ARRAY value designated by this Array object. This method uses the specified map for type map customizations unless the base type of the array does not match a user-defined type in map, in which case it uses the standard mapping. This version of the method getResultSet uses either the given type map or the standard mapping; it never uses the type map associated with the connection.

Parameters

map:Map<String, Class<?>>: contains the mapping of SQL user-defined types to classes in the Java programming language

Returns:ResultSet

a ResultSet object containing one row for each of the elements in the array designated by this Array object, with the rows in ascending order based on the indices.

Annotations

@Override

getResultSet back to summary

getResultSet	back to summary
public ResultSet getResultSet(long index, int count) throws SQLException Implements java.sql.Array.getResultSet. Doc from java.sql.Array.getResultSet. Retrieves a result set holding the elements of the subarray that starts at index `index` and contains up to `count` successive elements. This method uses the connection's type map to map the elements of the array if the map contains an entry for the base type. Otherwise, the standard mapping is used. The result set has one row for each element of the SQL array designated by this object, with the first row containing the element at index `index`. The result set has up to `count` rows in ascending order based on the indices. Each row has two columns: The second column stores the element value; the first column stores the index into the array for that element. Parameters index:long the array index of the first element to retrieve; the first element is at index 1 count:int the number of successive SQL array elements to retrieve Returns:ResultSet a `ResultSet` object containing up to `count` consecutive elements of the SQL array designated by this `Array` object, starting at index `index`. Annotations @Override Exceptions SQLException: if an error occurs while attempting to access the array

public ResultSet getResultSet(long index, int count) throws SQLException

Implements java.sql.Array.getResultSet.

Doc from java.sql.Array.getResultSet.

Retrieves a result set holding the elements of the subarray that starts at index index and contains up to count successive elements. This method uses the connection's type map to map the elements of the array if the map contains an entry for the base type. Otherwise, the standard mapping is used.

The result set has one row for each element of the SQL array designated by this object, with the first row containing the element at index index. The result set has up to count rows in ascending order based on the indices. Each row has two columns: The second column stores the element value; the first column stores the index into the array for that element.

Parameters

index:long: the array index of the first element to retrieve; the first element is at index 1
count:int: the number of successive SQL array elements to retrieve

Returns:ResultSet

a ResultSet object containing up to count consecutive elements of the SQL array designated by this Array object, starting at index index.

Annotations

@Override

Exceptions

SQLException:: if an error occurs while attempting to access the array

getResultSet back to summary

getResultSet	back to summary
public ResultSet getResultSet(long index, int count, Map<String, Class<?>> map) throws SQLException Implements java.sql.Array.getResultSet. Doc from java.sql.Array.getResultSet. Retrieves a result set holding the elements of the subarray that starts at index `index` and contains up to `count` successive elements. This method uses the specified `map` for type map customizations unless the base type of the array does not match a user-defined type in `map`, in which case it uses the standard mapping. This version of the method `getResultSet` uses either the given type map or the standard mapping; it never uses the type map associated with the connection. The result set has one row for each element of the SQL array designated by this object, with the first row containing the element at index `index`. The result set has up to `count` rows in ascending order based on the indices. Each row has two columns: The second column stores the element value; the first column stores the index into the array for that element. Parameters index:long the array index of the first element to retrieve; the first element is at index 1 count:int the number of successive SQL array elements to retrieve map:Map<String, Class<?>> the `Map` object that contains the mapping of SQL type names to classes in the Java(tm) programming language Returns:ResultSet a `ResultSet` object containing up to `count` consecutive elements of the SQL array designated by this `Array` object, starting at index `index`. Annotations @Override Exceptions SQLException: if an error occurs while attempting to access the array

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

Implements java.sql.Array.getResultSet.

Doc from java.sql.Array.getResultSet.

Retrieves a result set holding the elements of the subarray that starts at index index and contains up to count successive elements. This method uses the specified map for type map customizations unless the base type of the array does not match a user-defined type in map, in which case it uses the standard mapping. This version of the method getResultSet uses either the given type map or the standard mapping; it never uses the type map associated with the connection.

Parameters

index:long: the array index of the first element to retrieve; the first element is at index 1
count:int: the number of successive SQL array elements to retrieve
map:Map<String, Class<?>>: the Map object that contains the mapping of SQL type names to classes in the Java(tm) programming language

Returns:ResultSet

a ResultSet object containing up to count consecutive elements of the SQL array designated by this Array object, starting at index index.

Annotations

@Override

Exceptions

SQLException:: if an error occurs while attempting to access the array

getResultSet0	back to summary
private ResultSet getResultSet0(T[] a) Annotations @SuppressWarnings:unchecked

public Class MockArray<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail