org.postgresql.jdbc

Interface ArrayEncoding.ArrayEncoder<A>

All Known Implementing Classes:

ArrayEncoding.AbstractArrayEncoder, ArrayEncoding.FixedSizePrimitiveArrayEncoder, ArrayEncoding.NumberArrayEncoder, ArrayEncoding.RecursiveArrayEncoder, ArrayEncoding.TwoDimensionPrimitiveArrayEncoder

Enclosing class:

ArrayEncoding

static interface ArrayEncoding.ArrayEncoder<A>

Method Summary

Modifier and Type	Method and Description
void	appendArray(java.lang.StringBuilder sb, char delim, A array) Append String representation of array to sb.
int	getDefaultArrayTypeOid() The default array type oid supported by this instance.
boolean	supportBinaryRepresentation(int oid) Indicates if an array can be encoded in binary form to array oid.
java.lang.String	toArrayString(char delim, A array) Creates String representation of the array.
byte[]	toBinaryRepresentation(BaseConnection connection, A array, int oid) Creates binary representation of the array.

Method Detail

getDefaultArrayTypeOid

int getDefaultArrayTypeOid()

The default array type oid supported by this instance.

Returns:

The default array type oid supported by this instance.

toArrayString

java.lang.String toArrayString(char delim,
                               A array)

Creates String representation of the array.

Parameters:

delim - The character to use to delimit between elements.

array - The array to represent as a String.

Returns:

String representation of the array.

supportBinaryRepresentation

boolean supportBinaryRepresentation(int oid)

Indicates if an array can be encoded in binary form to array oid.

Parameters:

oid - The array oid to see check for binary support.

Returns:

Indication of whether toBinaryRepresentation(BaseConnection, Object, int) is supported for oid.

toBinaryRepresentation

byte[] toBinaryRepresentation(BaseConnection connection,
                              A array,
                              int oid)
                       throws java.sql.SQLException,
                              java.sql.SQLFeatureNotSupportedException

Creates binary representation of the array.

Parameters:

connection - The connection the binary representation will be used on. Attributes from the connection might impact how values are translated to binary.

array - The array to binary encode. Must not be null, but may contain null elements.

oid - The array type oid to use. Calls to supportBinaryRepresentation(int) must have returned true.

Returns:

The binary representation of array.

Throws:

java.sql.SQLFeatureNotSupportedException - If supportBinaryRepresentation(int) is false for oid.

java.sql.SQLException

appendArray

void appendArray(java.lang.StringBuilder sb,
                 char delim,
                 A array)

Append String representation of array to sb.

Parameters:

sb - The StringBuilder to append to.

delim - The delimiter between elements.

array - The array to represent. Will not be null, but may contain null elements.