APIdia Launch Partner
Top Description Methods
java.sql

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

Method Summary

Modifier and TypeMethod and Description
public void
writeArray(Array
an Array object representing data of an SQL ARRAY type
x)

Writes an SQL ARRAY value to the stream.

public void
writeAsciiStream(InputStream
the value to pass to the database
x)

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

public void
writeBigDecimal(BigDecimal
the value to pass to the database
x)

Writes the next attribute to the stream as a java.math.BigDecimal object.

public void
writeBinaryStream(InputStream
the value to pass to the database
x)

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

public void
writeBlob(Blob
a Blob object representing data of an SQL BLOB value
x)

Writes an SQL BLOB value to the stream.

public void
writeBoolean(boolean
the value to pass to the database
x)

Writes the next attribute to the stream as a Java boolean.

public void
writeByte(byte
the value to pass to the database
x)

Writes the next attribute to the stream as a Java byte.

public void
writeBytes(byte[]
the value to pass to the database
x)

Writes the next attribute to the stream as an array of bytes.

public void
writeCharacterStream(Reader
the value to pass to the database
x)

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

public void
writeClob(Clob
a Clob object representing data of an SQL CLOB value
x)

Writes an SQL CLOB value to the stream.

public void
writeDate(Date
the value to pass to the database
x)

Writes the next attribute to the stream as a java.sql.Date object.

public void
writeDouble(double
the value to pass to the database
x)

Writes the next attribute to the stream as a Java double.

public void
writeFloat(float
the value to pass to the database
x)

Writes the next attribute to the stream as a Java float.

public void
writeInt(int
the value to pass to the database
x)

Writes the next attribute to the stream as a Java int.

public void
writeLong(long
the value to pass to the database
x)

Writes the next attribute to the stream as a Java long.

public void
writeNClob(NClob
a NClob object representing data of an SQL NCLOB value
x)

Writes an SQL NCLOB value to the stream.

public void
writeNString(String
the value to pass to the database
x)

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

public void
writeObject(SQLData
the object representing data of an SQL structured or distinct type
x)

Writes to the stream the data contained in the given SQLData object.

public default void
writeObject(Object
the object containing the input parameter value
x, SQLType
the SQL type to be sent to the database.
targetSqlType)

Writes to the stream the data contained in the given object.

public void
writeRef(Ref
a Ref object representing data of an SQL REF value
x)

Writes an SQL REF value to the stream.

public void
writeRowId(RowId
a RowId object representing data of an SQL ROWID value
x)

Writes an SQL ROWID value to the stream.

public void
writeShort(short
the value to pass to the database
x)

Writes the next attribute to the stream as a Java short.

public void
writeSQLXML(SQLXML
a SQLXML object representing data of an SQL XML value
x)

Writes an SQL XML value to the stream.

public void
writeString(String
the value to pass to the database
x)

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

public void
writeStruct(Struct
a Struct object representing data of an SQL structured type
x)

Writes an SQL structured type value to the stream.

public void
writeTime(Time
the value to pass to the database
x)

Writes the next attribute to the stream as a java.sql.Time object.

public void
writeTimestamp(Timestamp
the value to pass to the database
x)

Writes the next attribute to the stream as a java.sql.Timestamp object.

public void
writeURL(URL
a java.net.URL object representing the data of SQL DATALINK type
x)

Writes a SQL DATALINK value to the stream.

Method Detail

writeArrayback to summary
public void writeArray(Array x) throws SQLException

Writes an SQL ARRAY value to the stream.

Parameters
x:Array

an Array object representing data of an SQL ARRAY type

Exceptions
SQLException:
if a database access error occurs
SQLFeatureNotSupportedException:
if the JDBC driver does not support this method
Since
1.2
writeAsciiStreamback to summary
public void writeAsciiStream(InputStream x) throws SQLException

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

Parameters
x:InputStream

the value to pass to the database

Exceptions
SQLException:
if a database access error occurs
SQLFeatureNotSupportedException:
if the JDBC driver does not support this method
Since
1.2
writeBigDecimalback to summary
public void writeBigDecimal(BigDecimal x) throws SQLException

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

Exceptions
SQLException:
if a database access error occurs
SQLFeatureNotSupportedException:
if the JDBC driver does not support this method
Since
1.2
writeBinaryStreamback to summary
public void writeBinaryStream(InputStream x) throws SQLException

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

Parameters
x:InputStream

the value to pass to the database

Exceptions
SQLException:
if a database access error occurs
SQLFeatureNotSupportedException:
if the JDBC driver does not support this method
Since
1.2
writeBlobback to summary
public void writeBlob(Blob x) throws SQLException

Writes an SQL BLOB value to the stream.

Parameters
x:Blob

a Blob object representing data of an SQL BLOB value

Exceptions
SQLException:
if a database access error occurs
SQLFeatureNotSupportedException:
if the JDBC driver does not support this method
Since
1.2
writeBooleanback to summary
public void writeBoolean(boolean x) throws SQLException

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

Exceptions
SQLException:
if a database access error occurs
SQLFeatureNotSupportedException:
if the JDBC driver does not support this method
Since
1.2
writeByteback to summary
public void writeByte(byte x) throws SQLException

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

Exceptions
SQLException:
if a database access error occurs
SQLFeatureNotSupportedException:
if the JDBC driver does not support this method
Since
1.2
writeBytesback to summary
public void writeBytes(byte[] x) throws SQLException

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

Exceptions
SQLException:
if a database access error occurs
SQLFeatureNotSupportedException:
if the JDBC driver does not support this method
Since
1.2
writeCharacterStreamback to summary
public void writeCharacterStream(Reader x) throws SQLException

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

Parameters
x:Reader

the value to pass to the database

Exceptions
SQLException:
if a database access error occurs
SQLFeatureNotSupportedException:
if the JDBC driver does not support this method
Since
1.2
writeClobback to summary
public void writeClob(Clob x) throws SQLException

Writes an SQL CLOB value to the stream.

Parameters
x:Clob

a Clob object representing data of an SQL CLOB value

Exceptions
SQLException:
if a database access error occurs
SQLFeatureNotSupportedException:
if the JDBC driver does not support this method
Since
1.2
writeDateback to summary
public void writeDate(Date x) throws SQLException

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

Exceptions
SQLException:
if a database access error occurs
SQLFeatureNotSupportedException:
if the JDBC driver does not support this method
Since
1.2
writeDoubleback to summary
public void writeDouble(double x) throws SQLException

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

Exceptions
SQLException:
if a database access error occurs
SQLFeatureNotSupportedException:
if the JDBC driver does not support this method
Since
1.2
writeFloatback to summary
public void writeFloat(float x) throws SQLException

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

Exceptions
SQLException:
if a database access error occurs
SQLFeatureNotSupportedException:
if the JDBC driver does not support this method
Since
1.2
writeIntback to summary
public void writeInt(int x) throws SQLException

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

Exceptions
SQLException:
if a database access error occurs
SQLFeatureNotSupportedException:
if the JDBC driver does not support this method
Since
1.2
writeLongback to summary
public void writeLong(long x) throws SQLException

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

Exceptions
SQLException:
if a database access error occurs
SQLFeatureNotSupportedException:
if the JDBC driver does not support this method
Since
1.2
writeNClobback to summary
public void writeNClob(NClob x) throws SQLException

Writes an SQL NCLOB value to the stream.

Parameters
x:NClob

a NClob object representing data of an SQL NCLOB value

Exceptions
SQLException:
if a database access error occurs
SQLFeatureNotSupportedException:
if the JDBC driver does not support this method
Since
1.6
writeNStringback to summary
public void writeNString(String x) throws SQLException

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

Exceptions
SQLException:
if a database access error occurs
SQLFeatureNotSupportedException:
if the JDBC driver does not support this method
Since
1.6
writeObjectback to summary
public void writeObject(SQLData x) throws SQLException

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.writeSQL 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

Exceptions
SQLException:
if a database access error occurs
SQLFeatureNotSupportedException:
if the JDBC driver does not support this method
Since
1.2
writeObjectback to summary
public default void writeObject(Object x, SQLType targetSqlType) throws SQLException

Writes 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 object is null, this method writes an SQL NULL to the stream.

If the object has a custom mapping (is of a class implementing the interface SQLData), the JDBC driver should call the method SQLData.writeSQL to write it to the SQL data stream. If, on the other hand, the object is of a class implementing Ref, Blob, Clob, NClob, Struct, java.net.URL, or Array, the driver should pass it to the database as a value of the corresponding SQL type.

The default implementation will throw SQLFeatureNotSupportedException

Parameters
x:Object

the object containing the input parameter value

targetSqlType:SQLType

the SQL type to be sent to the database.

Exceptions
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
JDBCType, SQLType
writeRefback to summary
public void writeRef(Ref x) throws SQLException

Writes an SQL REF value to the stream.

Parameters
x:Ref

a Ref object representing data of an SQL REF value

Exceptions
SQLException:
if a database access error occurs
SQLFeatureNotSupportedException:
if the JDBC driver does not support this method
Since
1.2
writeRowIdback to summary
public void writeRowId(RowId x) throws SQLException

Writes an SQL ROWID value to the stream.

Parameters
x:RowId

a RowId object representing data of an SQL ROWID value

Exceptions
SQLException:
if a database access error occurs
SQLFeatureNotSupportedException:
if the JDBC driver does not support this method
Since
1.6
writeShortback to summary
public void writeShort(short x) throws SQLException

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

Exceptions
SQLException:
if a database access error occurs
SQLFeatureNotSupportedException:
if the JDBC driver does not support this method
Since
1.2
writeSQLXMLback to summary
public void writeSQLXML(SQLXML x) throws SQLException

Writes an SQL XML value to the stream.

Parameters
x:SQLXML

a SQLXML object representing data of an SQL XML value

Exceptions
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
Since
1.6
writeStringback to summary
public void writeString(String x) throws SQLException

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

Exceptions
SQLException:
if a database access error occurs
SQLFeatureNotSupportedException:
if the JDBC driver does not support this method
Since
1.2
writeStructback to summary
public void writeStruct(Struct x) throws SQLException

Writes an SQL structured type value to the stream.

Parameters
x:Struct

a Struct object representing data of an SQL structured type

Exceptions
SQLException:
if a database access error occurs
SQLFeatureNotSupportedException:
if the JDBC driver does not support this method
Since
1.2
writeTimeback to summary
public void writeTime(Time x) throws SQLException

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

Exceptions
SQLException:
if a database access error occurs
SQLFeatureNotSupportedException:
if the JDBC driver does not support this method
Since
1.2
writeTimestampback to summary
public void writeTimestamp(Timestamp x) throws SQLException

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

Exceptions
SQLException:
if a database access error occurs
SQLFeatureNotSupportedException:
if the JDBC driver does not support this method
Since
1.2
writeURLback to summary
public void writeURL(URL x) throws SQLException

Writes a SQL DATALINK value to the stream.

Parameters
x:URL

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

Exceptions
SQLException:
if a database access error occurs
SQLFeatureNotSupportedException:
if the JDBC driver does not support this method
Since
1.4