Interface SQLOutput
- All Known Implementing Classes:
- SQLOutputImpl
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
- 
Method SummaryModifier and TypeMethodDescriptionvoidwriteArray(Array x) Writes an SQLARRAYvalue to the stream.voidWrites the next attribute to the stream as a stream of ASCII characters.voidWrites the next attribute to the stream as a java.math.BigDecimal object.voidWrites the next attribute to the stream as a stream of uninterpreted bytes.voidWrites an SQLBLOBvalue to the stream.voidwriteBoolean(boolean x) Writes the next attribute to the stream as a Java boolean.voidwriteByte(byte x) Writes the next attribute to the stream as a Java byte.voidwriteBytes(byte[] x) Writes the next attribute to the stream as an array of bytes.voidWrites the next attribute to the stream as a stream of Unicode characters.voidWrites an SQLCLOBvalue to the stream.voidWrites the next attribute to the stream as a java.sql.Date object.voidwriteDouble(double x) Writes the next attribute to the stream as a Java double.voidwriteFloat(float x) Writes the next attribute to the stream as a Java float.voidwriteInt(int x) Writes the next attribute to the stream as a Java int.voidwriteLong(long x) Writes the next attribute to the stream as a Java long.voidwriteNClob(NClob x) Writes an SQLNCLOBvalue to the stream.voidWrites the next attribute to the stream as aStringin the Java programming language.default voidwriteObject(Object x, SQLType targetSqlType) Writes to the stream the data contained in the given object.voidWrites to the stream the data contained in the givenSQLDataobject.voidWrites an SQLREFvalue to the stream.voidwriteRowId(RowId x) Writes an SQLROWIDvalue to the stream.voidwriteShort(short x) Writes the next attribute to the stream as a Java short.voidWrites an SQLXMLvalue to the stream.voidWrites the next attribute to the stream as aStringin the Java programming language.voidWrites an SQL structured type value to the stream.voidWrites the next attribute to the stream as a java.sql.Time object.voidWrites the next attribute to the stream as a java.sql.Timestamp object.voidWrites a SQLDATALINKvalue to the stream.
- 
Method Details- 
writeStringWrites the next attribute to the stream as aStringin the Java programming language.- Parameters:
- x- 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
- Since:
- 1.2
 
- 
writeBooleanWrites the next attribute to the stream as a Java boolean. Writes the next attribute to the stream as aStringin the Java programming language.- Parameters:
- x- 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
- Since:
- 1.2
 
- 
writeByteWrites the next attribute to the stream as a Java byte. Writes the next attribute to the stream as aStringin the Java programming language.- Parameters:
- x- 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
- Since:
- 1.2
 
- 
writeShortWrites the next attribute to the stream as a Java short. Writes the next attribute to the stream as aStringin the Java programming language.- Parameters:
- x- 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
- Since:
- 1.2
 
- 
writeIntWrites the next attribute to the stream as a Java int. Writes the next attribute to the stream as aStringin the Java programming language.- Parameters:
- x- 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
- Since:
- 1.2
 
- 
writeLongWrites the next attribute to the stream as a Java long. Writes the next attribute to the stream as aStringin the Java programming language.- Parameters:
- x- 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
- Since:
- 1.2
 
- 
writeFloatWrites the next attribute to the stream as a Java float. Writes the next attribute to the stream as aStringin the Java programming language.- Parameters:
- x- 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
- Since:
- 1.2
 
- 
writeDoubleWrites the next attribute to the stream as a Java double. Writes the next attribute to the stream as aStringin the Java programming language.- Parameters:
- x- 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
- Since:
- 1.2
 
- 
writeBigDecimalWrites the next attribute to the stream as a java.math.BigDecimal object. Writes the next attribute to the stream as aStringin the Java programming language.- Parameters:
- x- 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
- Since:
- 1.2
 
- 
writeBytesWrites the next attribute to the stream as an array of bytes. Writes the next attribute to the stream as aStringin the Java programming language.- Parameters:
- x- 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
- Since:
- 1.2
 
- 
writeDateWrites the next attribute to the stream as a java.sql.Date object. Writes the next attribute to the stream as ajava.sql.Dateobject in the Java programming language.- Parameters:
- x- 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
- Since:
- 1.2
 
- 
writeTimeWrites the next attribute to the stream as a java.sql.Time object. Writes the next attribute to the stream as ajava.sql.Dateobject in the Java programming language.- Parameters:
- x- 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
- Since:
- 1.2
 
- 
writeTimestampWrites the next attribute to the stream as a java.sql.Timestamp object. Writes the next attribute to the stream as ajava.sql.Dateobject in the Java programming language.- Parameters:
- x- 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
- Since:
- 1.2
 
- 
writeCharacterStreamWrites the next attribute to the stream as a stream of Unicode characters.- Parameters:
- x- 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
- Since:
- 1.2
 
- 
writeAsciiStreamWrites the next attribute to the stream as a stream of ASCII characters.- Parameters:
- x- 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
- Since:
- 1.2
 
- 
writeBinaryStreamWrites the next attribute to the stream as a stream of uninterpreted bytes.- Parameters:
- x- 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
- Since:
- 1.2
 
- 
writeObjectWrites to the stream the data contained in the givenSQLDataobject. When theSQLDataobject isnull, this method writes an SQLNULLto the stream. Otherwise, it calls theSQLData.writeSQLmethod of the given object, which writes the object's attributes to the stream. The implementation of the methodSQLData.writeSQLcalls the appropriateSQLOutputwriter method(s) for writing each of the object's attributes in order. The attributes must be read from anSQLInputinput stream and written to anSQLOutputoutput stream in the same order in which they were listed in the SQL definition of the user-defined type.- Parameters:
- x- 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
- Since:
- 1.2
 
- 
writeRefWrites an SQLREFvalue to the stream.- Parameters:
- x- a- Refobject representing data of an SQL- REFvalue
- Throws:
- SQLException- if a database access error occurs
- SQLFeatureNotSupportedException- if the JDBC driver does not support this method
- Since:
- 1.2
 
- 
writeBlobWrites an SQLBLOBvalue to the stream.- Parameters:
- x- a- Blobobject representing data of an SQL- BLOBvalue
- Throws:
- SQLException- if a database access error occurs
- SQLFeatureNotSupportedException- if the JDBC driver does not support this method
- Since:
- 1.2
 
- 
writeClobWrites an SQLCLOBvalue to the stream.- Parameters:
- x- a- Clobobject representing data of an SQL- CLOBvalue
- Throws:
- SQLException- if a database access error occurs
- SQLFeatureNotSupportedException- if the JDBC driver does not support this method
- Since:
- 1.2
 
- 
writeStructWrites an SQL structured type value to the stream.- Parameters:
- x- a- Structobject 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
- Since:
- 1.2
 
- 
writeArrayWrites an SQLARRAYvalue to the stream.- Parameters:
- x- an- Arrayobject representing data of an SQL- ARRAYtype
- Throws:
- SQLException- if a database access error occurs
- SQLFeatureNotSupportedException- if the JDBC driver does not support this method
- Since:
- 1.2
 
- 
writeURLWrites a SQLDATALINKvalue to the stream.- Parameters:
- x- a- java.net.URLobject 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
- Since:
- 1.4
 
- 
writeNStringWrites the next attribute to the stream as aStringin the Java programming language. The driver converts this to a SQLNCHARorNVARCHARorLONGNVARCHARvalue (depending on the argument's size relative to the driver's limits onNVARCHARvalues) when it sends it to the stream.- Parameters:
- x- 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
- Since:
- 1.6
 
- 
writeNClobWrites an SQLNCLOBvalue to the stream.- Parameters:
- x- a- NClobobject representing data of an SQL- NCLOBvalue
- Throws:
- SQLException- if a database access error occurs
- SQLFeatureNotSupportedException- if the JDBC driver does not support this method
- Since:
- 1.6
 
- 
writeRowIdWrites an SQLROWIDvalue to the stream.- Parameters:
- x- a- RowIdobject representing data of an SQL- ROWIDvalue
- Throws:
- SQLException- if a database access error occurs
- SQLFeatureNotSupportedException- if the JDBC driver does not support this method
- Since:
- 1.6
 
- 
writeSQLXMLWrites an SQLXMLvalue to the stream.- Parameters:
- x- a- SQLXMLobject representing data of an SQL- XMLvalue
- Throws:
- SQLException- if a database access error occurs, the- java.xml.transform.Result,- Writeror- OutputStreamhas not been closed for the- SQLXMLobject or if there is an error processing the XML value. The- getCausemethod 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
- Since:
- 1.6
 
- 
writeObjectWrites to the stream the data contained in the given object. The object will be converted to the specified targetSqlType before being sent to the stream.When the objectisnull, this method writes an SQLNULLto the stream.If the object has a custom mapping (is of a class implementing the interface SQLData), the JDBC driver should call the methodSQLData.writeSQLto write it to the SQL data stream. If, on the other hand, the object is of a class implementingRef,Blob,Clob,NClob,Struct,java.net.URL, orArray, the driver should pass it to the database as a value of the corresponding SQL type.The default implementation will throw SQLFeatureNotSupportedException- Parameters:
- x- the object containing the input parameter value
- targetSqlType- the SQL type to be sent to the database.
- Throws:
- SQLException- if a database access error occurs or if the Java Object specified by x is an InputStream or Reader object and the value of the scale parameter is less than zero
- SQLFeatureNotSupportedException- if the JDBC driver does not support this data type
- Since:
- 1.8
- See Also:
 
 
-