Added in API level 1

SQLOutput

public interface SQLOutput

java.sql.SQLOutput

---

The output stream for writing the attributes of a user-defined type back to the database. This interface, used only for custom mapping, is used by the driver, and its methods are never directly invoked by a programmer.

When an object of a class implementing the interface SQLData is passed as an argument to an SQL statement, the JDBC driver calls the method SQLData.getSQLType to determine the kind of SQL datum being passed to the database. The driver then creates an instance of SQLOutput and passes it to the method SQLData.writeSQL. The method writeSQL in turn calls the appropriate SQLOutput writer methods writeBoolean, writeCharacterStream, and so on) to write data from the SQLData object to the SQLOutput output stream as the representation of an SQL user-defined type.

Summary

Public methods
abstract void	writeArray(Array x) Writes an SQL ARRAY value to the stream.
abstract void	writeAsciiStream(InputStream x) Writes the next attribute to the stream as a stream of ASCII characters.
abstract void	writeBigDecimal(BigDecimal x) Writes the next attribute to the stream as a java.math.BigDecimal object.
abstract void	writeBinaryStream(InputStream x) Writes the next attribute to the stream as a stream of uninterpreted bytes.
abstract void	writeBlob(Blob x) Writes an SQL BLOB value to the stream.
abstract void	writeBoolean(boolean x) Writes the next attribute to the stream as a Java boolean.
abstract void	writeByte(byte x) Writes the next attribute to the stream as a Java byte.
abstract void	writeBytes(byte[] x) Writes the next attribute to the stream as an array of bytes.
abstract void	writeCharacterStream(Reader x) Writes the next attribute to the stream as a stream of Unicode characters.
abstract void	writeClob(Clob x) Writes an SQL CLOB value to the stream.
abstract void	writeDate(Date x) Writes the next attribute to the stream as a java.sql.Date object.
abstract void	writeDouble(double x) Writes the next attribute to the stream as a Java double.
abstract void	writeFloat(float x) Writes the next attribute to the stream as a Java float.
abstract void	writeInt(int x) Writes the next attribute to the stream as a Java int.
abstract void	writeLong(long x) Writes the next attribute to the stream as a Java long.
abstract void	writeNClob(NClob x) Writes an SQL NCLOB value to the stream.
abstract void	writeNString(String x) Writes the next attribute to the stream as a String in the Java programming language.
abstract void	writeObject(SQLData x) Writes to the stream the data contained in the given SQLData object.
abstract void	writeRef(Ref x) Writes an SQL REF value to the stream.
abstract void	writeRowId(RowId x) Writes an SQL ROWID value to the stream.
abstract void	writeSQLXML(SQLXML x) Writes an SQL XML value to the stream.
abstract void	writeShort(short x) Writes the next attribute to the stream as a Java short.
abstract void	writeString(String x) Writes the next attribute to the stream as a String in the Java programming language.
abstract void	writeStruct(Struct x) Writes an SQL structured type value to the stream.
abstract void	writeTime(Time x) Writes the next attribute to the stream as a java.sql.Time object.
abstract void	writeTimestamp(Timestamp x) Writes the next attribute to the stream as a java.sql.Timestamp object.
abstract void	writeURL(URL x) Writes a SQL DATALINK value to the stream.

Public methods

writeArray

Added in API level 1

public abstract void writeArray (Array x)

Writes an SQL ARRAY value to the stream.

Parameters
x	Array: an Array object representing data of an SQL ARRAY type

Throws
SQLException	if a database access error occurs
SQLFeatureNotSupportedException	if the JDBC driver does not support this method

writeAsciiStream

Added in API level 1

public abstract void writeAsciiStream (InputStream x)

Writes the next attribute to the stream as a stream of ASCII characters.

Parameters
x	InputStream: the value to pass to the database

Throws
SQLException	if a database access error occurs
SQLFeatureNotSupportedException	if the JDBC driver does not support this method

writeBigDecimal

Added in API level 1

public abstract void writeBigDecimal (BigDecimal x)

Writes the next attribute to the stream as a java.math.BigDecimal object. Writes the next attribute to the stream as a String in the Java programming language.

Parameters
x	BigDecimal: the value to pass to the database

Throws
SQLException	if a database access error occurs
SQLFeatureNotSupportedException	if the JDBC driver does not support this method

writeBinaryStream

Added in API level 1

public abstract void writeBinaryStream (InputStream x)

Writes the next attribute to the stream as a stream of uninterpreted bytes.

Parameters
x	InputStream: the value to pass to the database

Throws
SQLException	if a database access error occurs
SQLFeatureNotSupportedException	if the JDBC driver does not support this method

writeBlob

Added in API level 1

public abstract void writeBlob (Blob x)

Writes an SQL BLOB value to the stream.

Parameters
x	Blob: a Blob object representing data of an SQL BLOB value

Throws
SQLException	if a database access error occurs
SQLFeatureNotSupportedException	if the JDBC driver does not support this method

writeBoolean

Added in API level 1

public abstract void writeBoolean (boolean x)

Writes the next attribute to the stream as a Java boolean. Writes the next attribute to the stream as a String in the Java programming language.

Parameters
x	boolean: the value to pass to the database

Throws
SQLException	if a database access error occurs
SQLFeatureNotSupportedException	if the JDBC driver does not support this method

writeByte

Added in API level 1

public abstract void writeByte (byte x)

Writes the next attribute to the stream as a Java byte. Writes the next attribute to the stream as a String in the Java programming language.

Parameters
x	byte: the value to pass to the database

Throws
SQLException	if a database access error occurs
SQLFeatureNotSupportedException	if the JDBC driver does not support this method

writeBytes

Added in API level 1

public abstract void writeBytes (byte[] x)

Writes the next attribute to the stream as an array of bytes. Writes the next attribute to the stream as a String in the Java programming language.

Parameters
x	byte: the value to pass to the database

Throws
SQLException	if a database access error occurs
SQLFeatureNotSupportedException	if the JDBC driver does not support this method

writeCharacterStream

Added in API level 1

public abstract void writeCharacterStream (Reader x)

Writes the next attribute to the stream as a stream of Unicode characters.

Parameters
x	Reader: the value to pass to the database

Throws
SQLException	if a database access error occurs
SQLFeatureNotSupportedException	if the JDBC driver does not support this method

writeClob

Added in API level 1

public abstract void writeClob (Clob x)

Writes an SQL CLOB value to the stream.

Parameters
x	Clob: a Clob object representing data of an SQL CLOB value

Throws
SQLException	if a database access error occurs
SQLFeatureNotSupportedException	if the JDBC driver does not support this method

writeDate

Added in API level 1

public abstract void writeDate (Date x)

Writes the next attribute to the stream as a java.sql.Date object. Writes the next attribute to the stream as a java.sql.Date object in the Java programming language.

Parameters
x	Date: the value to pass to the database

Throws
SQLException	if a database access error occurs
SQLFeatureNotSupportedException	if the JDBC driver does not support this method

writeDouble

Added in API level 1

public abstract void writeDouble (double x)

Writes the next attribute to the stream as a Java double. Writes the next attribute to the stream as a String in the Java programming language.

Parameters
x	double: the value to pass to the database

Throws
SQLException	if a database access error occurs
SQLFeatureNotSupportedException	if the JDBC driver does not support this method

writeFloat

Added in API level 1

public abstract void writeFloat (float x)

Writes the next attribute to the stream as a Java float. Writes the next attribute to the stream as a String in the Java programming language.

Parameters
x	float: the value to pass to the database

Throws
SQLException	if a database access error occurs
SQLFeatureNotSupportedException	if the JDBC driver does not support this method

writeInt

Added in API level 1

public abstract void writeInt (int x)

Writes the next attribute to the stream as a Java int. Writes the next attribute to the stream as a String in the Java programming language.

Parameters
x	int: the value to pass to the database

Throws
SQLException	if a database access error occurs
SQLFeatureNotSupportedException	if the JDBC driver does not support this method

writeLong

Added in API level 1

public abstract void writeLong (long x)

Writes the next attribute to the stream as a Java long. Writes the next attribute to the stream as a String in the Java programming language.

Parameters
x	long: the value to pass to the database

Throws
SQLException	if a database access error occurs
SQLFeatureNotSupportedException	if the JDBC driver does not support this method

writeNClob

Added in API level 9

public abstract void writeNClob (NClob x)

Writes an SQL NCLOB value to the stream.

Parameters
x	NClob: a NClob object representing data of an SQL NCLOB value

Throws
SQLException	if a database access error occurs
SQLFeatureNotSupportedException	if the JDBC driver does not support this method

writeNString

Added in API level 9

public abstract void writeNString (String x)

Writes the next attribute to the stream as a String in the Java programming language. The driver converts this to a SQL NCHAR or NVARCHAR or LONGNVARCHAR value (depending on the argument's size relative to the driver's limits on NVARCHAR values) when it sends it to the stream.

Parameters
x	String: the value to pass to the database

Throws
SQLException	if a database access error occurs
SQLFeatureNotSupportedException	if the JDBC driver does not support this method

writeObject

Added in API level 1

public abstract void writeObject (SQLData x)

Writes to the stream the data contained in the given SQLData object. When the SQLData object is null, this method writes an SQL NULL to the stream. Otherwise, it calls the SQLData.writeSQL method of the given object, which writes the object's attributes to the stream. The implementation of the method SQLData.writeSQ calls the appropriate SQLOutput writer method(s) for writing each of the object's attributes in order. The attributes must be read from an SQLInput input stream and written to an SQLOutput output stream in the same order in which they were listed in the SQL definition of the user-defined type.

Parameters
x	SQLData: the object representing data of an SQL structured or distinct type

Throws
SQLException	if a database access error occurs
SQLFeatureNotSupportedException	if the JDBC driver does not support this method

writeRef

Added in API level 1

public abstract void writeRef (Ref x)

Writes an SQL REF value to the stream.

Parameters
x	Ref: a Ref object representing data of an SQL REF value

Throws
SQLException	if a database access error occurs
SQLFeatureNotSupportedException	if the JDBC driver does not support this method

writeRowId

Added in API level 9

public abstract void writeRowId (RowId x)

Writes an SQL ROWID value to the stream.

Parameters
x	RowId: a RowId object representing data of an SQL ROWID value

Throws
SQLException	if a database access error occurs
SQLFeatureNotSupportedException	if the JDBC driver does not support this method

writeSQLXML

Added in API level 9

public abstract void writeSQLXML (SQLXML x)

Writes an SQL XML value to the stream.

Parameters
x	SQLXML: a SQLXML object representing data of an SQL XML value

Throws
SQLException	if a database access error occurs, the java.xml.transform.Result, Writer or OutputStream has not been closed for the SQLXML object or if there is an error processing the XML value. The getCause method of the exception may provide a more detailed exception, for example, if the stream does not contain valid XML.
SQLFeatureNotSupportedException	if the JDBC driver does not support this method

writeShort

Added in API level 1

public abstract void writeShort (short x)

Writes the next attribute to the stream as a Java short. Writes the next attribute to the stream as a String in the Java programming language.

Parameters
x	short: the value to pass to the database

Throws
SQLException	if a database access error occurs
SQLFeatureNotSupportedException	if the JDBC driver does not support this method

writeString

Added in API level 1

public abstract void writeString (String x)

Writes the next attribute to the stream as a String in the Java programming language.

Parameters
x	String: the value to pass to the database

Throws
SQLException	if a database access error occurs
SQLFeatureNotSupportedException	if the JDBC driver does not support this method

writeStruct

Added in API level 1

public abstract void writeStruct (Struct x)

Writes an SQL structured type value to the stream.

Parameters
x	Struct: a Struct object representing data of an SQL structured type

Throws
SQLException	if a database access error occurs
SQLFeatureNotSupportedException	if the JDBC driver does not support this method

writeTime

Added in API level 1

public abstract void writeTime (Time x)

Writes the next attribute to the stream as a java.sql.Time object. Writes the next attribute to the stream as a java.sql.Date object in the Java programming language.

Parameters
x	Time: the value to pass to the database

Throws
SQLException	if a database access error occurs
SQLFeatureNotSupportedException	if the JDBC driver does not support this method

writeTimestamp

Added in API level 1

public abstract void writeTimestamp (Timestamp x)

Writes the next attribute to the stream as a java.sql.Timestamp object. Writes the next attribute to the stream as a java.sql.Date object in the Java programming language.

Parameters
x	Timestamp: the value to pass to the database

Throws
SQLException	if a database access error occurs
SQLFeatureNotSupportedException	if the JDBC driver does not support this method

writeURL

Added in API level 1

public abstract void writeURL (URL x)

Writes a SQL DATALINK value to the stream.

Parameters
x	URL: a java.net.URL object representing the data of SQL DATALINK type

Throws
SQLException	if a database access error occurs
SQLFeatureNotSupportedException	if the JDBC driver does not support this method