FileDocCategorySizeDatePackage
SQLOutput.javaAPI DocJava SE 6 API15333Tue Jun 10 00:25:50 BST 2008java.sql

SQLOutput

public interface 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.

since
1.2

Fields Summary
Constructors Summary
Methods Summary
public voidwriteArray(java.sql.Array x)
Writes an SQL ARRAY value to the stream.

param
x an Array object representing data of an SQL ARRAY type
exception
SQLException if a database access error occurs
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.2

public voidwriteAsciiStream(java.io.InputStream x)
Writes the next attribute to the stream as a stream of ASCII characters.

param
x the value to pass to the database
exception
SQLException if a database access error occurs
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.2

public voidwriteBigDecimal(java.math.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.

param
x the value to pass to the database
exception
SQLException if a database access error occurs
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.2

public voidwriteBinaryStream(java.io.InputStream x)
Writes the next attribute to the stream as a stream of uninterpreted bytes.

param
x the value to pass to the database
exception
SQLException if a database access error occurs
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.2

public voidwriteBlob(java.sql.Blob x)
Writes an SQL BLOB value to the stream.

param
x a Blob object representing data of an SQL BLOB value
exception
SQLException if a database access error occurs
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.2

public voidwriteBoolean(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.

param
x the value to pass to the database
exception
SQLException if a database access error occurs
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.2

public voidwriteByte(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.

param
x the value to pass to the database
exception
SQLException if a database access error occurs
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.2

public voidwriteBytes(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.

param
x the value to pass to the database
exception
SQLException if a database access error occurs
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.2

public voidwriteCharacterStream(java.io.Reader x)
Writes the next attribute to the stream as a stream of Unicode characters.

param
x the value to pass to the database
exception
SQLException if a database access error occurs
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.2

public voidwriteClob(java.sql.Clob x)
Writes an SQL CLOB value to the stream.

param
x a Clob object representing data of an SQL CLOB value
exception
SQLException if a database access error occurs
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.2

public voidwriteDate(java.sql.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.

param
x the value to pass to the database
exception
SQLException if a database access error occurs
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.2

public voidwriteDouble(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.

param
x the value to pass to the database
exception
SQLException if a database access error occurs
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.2

public voidwriteFloat(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.

param
x the value to pass to the database
exception
SQLException if a database access error occurs
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.2

public voidwriteInt(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.

param
x the value to pass to the database
exception
SQLException if a database access error occurs
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.2

public voidwriteLong(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.

param
x the value to pass to the database
exception
SQLException if a database access error occurs
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.2

public voidwriteNClob(java.sql.NClob x)
Writes an SQL NCLOB value to the stream.

param
x a NClob object representing data of an SQL NCLOB value
exception
SQLException if a database access error occurs
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.6

public voidwriteNString(java.lang.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.

param
x the value to pass to the database
exception
SQLException if a database access error occurs
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.6

public voidwriteObject(java.sql.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.

param
x the object representing data of an SQL structured or distinct type
exception
SQLException if a database access error occurs
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.2

public voidwriteRef(java.sql.Ref x)
Writes an SQL REF value to the stream.

param
x a Ref object representing data of an SQL REF value
exception
SQLException if a database access error occurs
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.2

public voidwriteRowId(java.sql.RowId x)
Writes an SQL ROWID value to the stream.

param
x a RowId object representing data of an SQL ROWID value
exception
SQLException if a database access error occurs
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.6

public voidwriteSQLXML(java.sql.SQLXML x)
Writes an SQL XML value to the stream.

param
x 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.
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.6

public voidwriteShort(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.

param
x the value to pass to the database
exception
SQLException if a database access error occurs
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.2

public voidwriteString(java.lang.String x)
Writes the next attribute to the stream as a String in the Java programming language.

param
x the value to pass to the database
exception
SQLException if a database access error occurs
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.2

public voidwriteStruct(java.sql.Struct x)
Writes an SQL structured type value to the stream.

param
x a Struct object representing data of an SQL structured type
exception
SQLException if a database access error occurs
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.2

public voidwriteTime(java.sql.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.

param
x the value to pass to the database
exception
SQLException if a database access error occurs
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.2

public voidwriteTimestamp(java.sql.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.

param
x the value to pass to the database
exception
SQLException if a database access error occurs
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.2

public voidwriteURL(java.net.URL x)
Writes a SQL DATALINK value to the stream.

param
x a java.net.URL object representing the data of SQL DATALINK type
exception
SQLException if a database access error occurs
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.4